org.attribyte.wp.model

Class Shortcode

java.lang.Object

org.attribyte.wp.model.Shortcode

public class Shortcode
extends java.lang.Object

A shortcode. See: https://codex.wordpress.org/Shortcode_API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Shortcode.Type The type (enclosing or self-closing).

Field Summary

Fields

Modifier and Type	Field and Description
com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>	attributes The attributes.
java.lang.String	content The content.
java.lang.String	name The name.

Constructor Summary

Constructors

Constructor and Description
Shortcode(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> attributes) Creates a shortcode without content.
Shortcode(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> attributes, java.lang.String content) Creates a shortcode with content.

Method Summary

Modifier and Type	Method and Description
static Shortcode	parse(java.lang.String shortcode) Parses a shortcode
static void	parse(java.lang.String str, ShortcodeParser.Handler handler) Parse an arbitrary string.
java.lang.String	positionalValue(int pos) Gets a positional attribute value.
java.util.List<java.lang.String>	positionalValues() Gets a list of any positional values.
java.lang.String	toString()
java.lang.String	value(java.lang.String name) Gets an attribute value.
Shortcode	withContent(java.lang.String content) Adds content to a shortcode.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public final java.lang.String name

The name.

attributes

public final com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> attributes

The attributes.

content

public final java.lang.String content

The content.

Constructor Detail

Shortcode

public Shortcode(java.lang.String name,
                 java.util.Map<java.lang.String,java.lang.String> attributes)

Creates a shortcode without content.

Parameters:

name - The name.

attributes - The attributes.

Shortcode

public Shortcode(java.lang.String name,
                 java.util.Map<java.lang.String,java.lang.String> attributes,
                 java.lang.String content)

Creates a shortcode with content.

Parameters:

name - The name.

attributes - The attributes.

content - The content.

Method Detail

withContent

public Shortcode withContent(java.lang.String content)

Adds content to a shortcode.

Parameters:

content - The content.

Returns:

The shortcode with content added.

value

public final java.lang.String value(java.lang.String name)

Gets an attribute value.

Parameters:

name - The attribute name.

Returns:

The value or null if no value for this attribute.

positionalValue

public final java.lang.String positionalValue(int pos)

Gets a positional attribute value.

Parameters:

pos - The position.

Returns:

The value, or null if no value at the position.

positionalValues

public final java.util.List<java.lang.String> positionalValues()

Gets a list of any positional values.

Returns:

The list of values.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

parse

public static Shortcode parse(java.lang.String shortcode)
                       throws java.text.ParseException

Parses a shortcode

Parameters:

shortcode - The shortcode string.

Returns:

The parsed shortcode.

Throws:

java.text.ParseException - on invalid code.

parse

public static void parse(java.lang.String str,
                         ShortcodeParser.Handler handler)

Parse an arbitrary string.

Parameters:

str - The string.

handler - The handler for parse events.