com.busit

Class Content

Object

Any

Content

All Implemented Interfaces:

Json.Decodable, Json.Encodable, Json.Encodable.Pretty, Iterable<Any>

public class Content
extends Any

Nested Class Summary

Nested classes/interfaces inherited from class Any

Any.Decodable, Any.Encodable

Nested classes/interfaces inherited from interface Json.Encodable

Json.Encodable.Pretty

Field Summary

Fields inherited from class Any

_value

Constructor Summary

Constructors

Constructor and Description
Content() Creates an instance of the default Content type with ID 0.
Content(int id) Creates an instance of the Content type specified by its ID.
Content(String id) Creates an instance of the Content type specified by its ID.

Method Summary

Methods

Modifier and Type	Method and Description
List<Integer>	compatibility() Retrieve the list of all compatible Content IDs in the form of an array.
boolean	compatible(int id) Gets the compatibility with another type.
boolean	compatible(int id, boolean value) Sets the compatibility with another type.
boolean	compatible(String id) Gets the compatibility with another type.
boolean	compatible(String id, boolean value) Sets the compatibility with another type.
String	htmlFormat() Gets the html format template for this Content.
String	htmlFormat(String format) Sets the html format template for this Content.
int	id() Gets the ID of the content type represented by this Content.
int	id(int id) Sets the ID of the content type represented by this Content.
Any	jsonSerialize() JSON serialization.
Content	jsonUnserialize(Any json) JSON unserialization.
Content	jsonUnserialize(String json) JSON unserialization.
Content	merge(Content content) Merges another content into this one.
String	textFormat() Gets the text format template for this Content.
String	textFormat(String format) Sets the text format template for this Content.
String	toHtml() Transform this Content into html.
String	toHtml(String format) Transform this Content into html.
String	toText() Transform this Content into text.
String	toText(String format) Transform this Content into text.

Methods inherited from class Any

add, add, add, addAll, addAll, addAll, as, as, as, as, asBool, asBool, asBool, asBool, asDouble, asDouble, asDouble, asDouble, asInt, asInt, asInt, asInt, asLong, asLong, asLong, asLong, asNumber, asNumber, asNumber, asNumber, asString, asString, asString, asString, clear, contains, containsAll, containsKey, containsValue, empty, emptyList, emptyMap, entrySet, equals, exists, exists, fromJson, get, get, getCaseSensitiveKey, hashCode, indexOf, is, is, is, is, isBool, isBool, isBool, isBool, isDouble, isDouble, isDouble, isDouble, isEmpty, isEmpty, isEmpty, isInt, isInt, isInt, isInt, isList, isList, isList, isList, isLong, isLong, isLong, isLong, isMap, isMap, isMap, isMap, isNull, isNull, isNull, isNull, isNumber, isNumber, isNumber, isNumber, isString, isString, isString, isString, isValue, isValue, isValue, isValue, iterator, keys, keySet, lastIndexOf, list, listIterator, listIterator, map, pipe, pipe, put, put, put, put, putAll, putAll, remove, removeAll, retainAll, set, set, size, subList, toArray, toArray, toJson, toJson, toJson, toJson, toJson, toJson, toString, unwrap, unwrap, unwrap, values, wrap

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Content

public Content(int id)

Creates an instance of the Content type specified by its ID. If id is 0, the default Content is created. If id is smaller than 0 or if an internal error occurs, then an empty Content is created.

Parameters:

id - the Content type ID

Content

public Content(String id)

Creates an instance of the Content type specified by its ID. If id is null, the default ID 0 is used.

Parameters:

id - the Content type ID

Content

public Content()

Creates an instance of the default Content type with ID 0.

Method Detail

merge

public Content merge(Content content)

Merges another content into this one. - The properties of the provided content are copied into the current content - The compatibility is adjusted to include all compatibilities of the provided content - The text format of the provided content is appended to the current with a "\n" separator - The html format of the provided content is appended to the current with a "
" separator - The uuid and timestamp of the current content are preserved - Properties common to both will be overwritten by the provided content's

Parameters:

content - the content to merge into this one

Returns:

the merged current content

compatible

public boolean compatible(int id)

Gets the compatibility with another type.

Parameters:

id - the other Content ID

Returns:

whether or not the current Content is compatible with the one specified

compatible

public boolean compatible(String id)

Gets the compatibility with another type.

Parameters:

id - the other Content ID

Returns:

whether or not the current Content is compatible with the one specified

compatible

public boolean compatible(int id,
                 boolean value)

Sets the compatibility with another type.

Parameters:

id - the other Content ID

value - whether or not the current Content is compatible with the one specified

Returns:

whether or not the current Content is compatible with the one specified

compatible

public boolean compatible(String id,
                 boolean value)

Sets the compatibility with another type.

Parameters:

id - the other Content ID

value - whether or not the current Content is compatible with the one specified

Returns:

whether or not the current Content is compatible with the one specified

compatibility

public List<Integer> compatibility()

Retrieve the list of all compatible Content IDs in the form of an array.

Returns:

List the list of compatible IDs

id

public int id(int id)

Sets the ID of the content type represented by this Content.

Parameters:

id - the content type ID

Returns:

id the content type ID

id

public int id()

Gets the ID of the content type represented by this Content.

Returns:

id the content type ID

textFormat

public String textFormat(String format)

Sets the text format template for this Content.

Parameters:

format - the text format template

Returns:

the text format template

textFormat

public String textFormat()

Gets the text format template for this Content.

Returns:

the text format template

htmlFormat

public String htmlFormat(String format)

Sets the html format template for this Content.

Parameters:

format - the html format template

Returns:

the html format template

htmlFormat

public String htmlFormat()

Gets the html format template for this Content.

Returns:

the html format template

toText

public String toText()

Transform this Content into text.

Returns:

the text representation of the Content

toHtml

public String toHtml()

Transform this Content into html.

Returns:

the html representation of the Content

toText

public String toText(String format)

Transform this Content into text.

Parameters:

format - the text format template

Returns:

the text representation of the Content

toHtml

public String toHtml(String format)

Transform this Content into html.

Parameters:

format - the html format template

Returns:

the html representation of the Content

jsonSerialize

public Any jsonSerialize()

JSON serialization.

Internal use only

jsonUnserialize

public Content jsonUnserialize(String json)

JSON unserialization.

Internal use only

jsonUnserialize

public Content jsonUnserialize(Any json)

JSON unserialization.

Internal use only