org.jomc.model

Class Text

java.lang.Object

org.jomc.model.Text

All Implemented Interfaces:

Cloneable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class Text
extends Object
implements Cloneable

Model of text. The 'Text' type defines attributes 'language', 'type' and 'value'. Attribute 'language' holds the language key identifying the text in a set of texts. Attribute 'type' specifies a Multipurpose Internet Mail Extension (MIME) type, as defined in RFC 2045 and 2046. Attribute 'value' holds the text of the type corresponding to the language.

Java class for Text complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Text">
   <simpleContent>
     <extension base="<http://jomc.org/model>String">
       <attribute name="language" use="required" type="{http://jomc.org/model}Language" />
       <attribute name="type" type="{http://jomc.org/model}MimeType" default="text/plain" />
     </extension>
   </simpleContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected String	language
protected String	type
protected String	value

Constructor Summary

Constructors

Constructor and Description
Text() Creates a new Text instance.
Text(Text o) Creates a new Text instance by deeply copying a given Text instance.

Method Summary

Methods

Modifier and Type	Method and Description
Text	clone() Creates and returns a deep copy of this object.
String	getJavadocComment(String lineSeparator, String indentation) Formats the text to a Javadoc comment.
String	getLanguage() The language key of this text.
javax.activation.MimeType	getMimeType() Gets the mime-type of the text.
String	getType() The Multipurpose Internet Mail Extension (MIME) type, as defined in RFC 2045 and 2046.
String	getValue() Gets the value of the value property.
void	setLanguage(String value) Sets the value of the language property.
void	setType(String value) Sets the value of the type property.
void	setValue(String value) Sets the value of the value property.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String value

language

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String language

type

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String type

Constructor Detail

Text

public Text()

Creates a new Text instance.

Text

public Text(Text o)

Creates a new Text instance by deeply copying a given Text instance.

Parameters:

o - The instance to copy.

Throws:

NullPointerException - if o is null.

Method Detail

getValue

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getValue()

Gets the value of the value property.

Returns:

possible object is String

setValue

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setValue(String value)

Sets the value of the value property.

Parameters:

value - allowed object is String

getLanguage

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getLanguage()

The language key of this text.

Returns:

possible object is String

setLanguage

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setLanguage(String value)

Sets the value of the language property.

Parameters:

value - allowed object is String

getType

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getType()

The Multipurpose Internet Mail Extension (MIME) type, as defined in RFC 2045 and 2046.

Returns:

possible object is String

setType

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setType(String value)

Sets the value of the type property.

Parameters:

value - allowed object is String

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2015-05-31T11:45:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Text clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class Object

Returns:

A deep copy of this object.

getMimeType

public javax.activation.MimeType getMimeType()
                                      throws ModelObjectException

Gets the mime-type of the text.

Returns:

The mime-type of the text.

Throws:

ModelObjectException - if compiling the type to a MimeType fails.

Since:

1.4

See Also:

getType()

getJavadocComment

public String getJavadocComment(String lineSeparator,
                       String indentation)
                         throws ModelObjectException

Formats the text to a Javadoc comment.

Parameters:

lineSeparator - String to use for separating lines.

indentation - String to prepend any lines with.

Returns:

The Javadoc comment of the text or null.

Throws:

NullPointerException - if lineSeparator or indentation is null.

ModelObjectException - if compiling the referenced type to a MimeType fails.

Since:

1.4