Package org.jboss.resteasy.plugins.providers.atom

Class Text

java.lang.Object

org.jboss.resteasy.plugins.providers.atom.CommonAttributes

org.jboss.resteasy.plugins.providers.atom.Text

public class Text
extends CommonAttributes

Represents an atomTextConstruct element.

Per RFC4287:

  A Text construct contains human-readable text, usually in small
  quantities. The content of Text constructs is Language-Sensitive.

  atomPlainTextConstruct =
     atomCommonAttributes,
     attribute type { "text" | "html" }?,
     text

  atomXHTMLTextConstruct =
    atomCommonAttributes,
    attribute type { "xhtml" },
    xhtmlDiv

  atomTextConstruct = atomPlainTextConstruct | atomXHTMLTextConstruct

 

Version:

$Revision: 1 $

Author:

Johannes Beck

Field Summary

Fields

Modifier and Type	Field	Description
protected JAXBContextFinder	finder

Constructor Summary

Constructors

Constructor	Description
Text()
Text(String text)
Text(String text, String type)

Method Summary

Modifier and Type	Method	Description
Element	getElement()	Get content as an XML Element if the content is XML.
Object	getJAXBObject()	Returns previous extracted jaxbobject from a call to getJAXBObject(Class<T> clazz) or value passed in through a previous setJAXBObject().
<T> T	getJAXBObject(Class<T> clazz, Class... otherPossibleClasses)	Extract the content as the provided JAXB annotated type.
String	getRawType()
String	getText()	If content is text, return it as a String.
jakarta.ws.rs.core.MediaType	getType()	Mime type.
List<Object>	getValue()
void	setElement(Element element)	Set the content to an XML Element.
protected void	setFinder(JAXBContextFinder finder)
void	setJAXBObject(Object obj)
void	setRawType(String type)
void	setText(String text)	Set content as text.
void	setType(jakarta.ws.rs.core.MediaType type)
void	setValue(List<Object> value)

Methods inherited from class org.jboss.resteasy.plugins.providers.atom.CommonAttributes

getBase, getExtensionAttributes, getLanguage, setBase, setLanguage

Methods inherited from class java.lang.Object

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

Field Detail

finder

protected JAXBContextFinder finder

Constructor Detail

Text

public Text()

Text

public Text(String text,
            String type)

Text

public Text(String text)

Method Detail

setFinder

protected void setFinder(JAXBContextFinder finder)

getValue

public List<Object> getValue()

setValue

public void setValue(List<Object> value)

getType

public jakarta.ws.rs.core.MediaType getType()

Mime type.

Returns:

media type

setType

public void setType(jakarta.ws.rs.core.MediaType type)

getRawType

public String getRawType()

setRawType

public void setRawType(String type)

getText

public String getText()

If content is text, return it as a String. Otherwise, if content is not text this will return null.

Returns:

text

setText

public void setText(String text)

Set content as text.

Parameters:

text - text

getElement

public Element getElement()

Get content as an XML Element if the content is XML. Otherwise, this will just return null.

Returns:

Element

setElement

public void setElement(Element element)

Set the content to an XML Element.

Parameters:

element - Element

getJAXBObject

public <T> T getJAXBObject(Class<T> clazz,
                           Class... otherPossibleClasses)
                    throws jakarta.xml.bind.JAXBException

Extract the content as the provided JAXB annotated type.

This method will use a cached JAXBContext used by the Resteasy JAXB providers or, if those are not existent, it will create a new JAXBContext from scratch using the class.

Parameters:

clazz - class type you are expecting

otherPossibleClasses - Other classe you want to create the JAXBContext with

Returns:

null if there is no XML content

Throws:

jakarta.xml.bind.JAXBException - jaxb exception

getJAXBObject

public Object getJAXBObject()

Returns previous extracted jaxbobject from a call to getJAXBObject(Class<T> clazz) or value passed in through a previous setJAXBObject().

Returns:

jaxb object

setJAXBObject

public void setJAXBObject(Object obj)