org.apache.ws.jaxme.xs.xml
Interface XsEDocumentation
- XsObject
- XsEDocumentationImpl
public interface XsEDocumentation
Interface of
xs:documentation
, as specified
by the following:
<xs:element name="documentation" id="documentation">
<xs:annotation>
<xs:documentation source="http://www.w3.org/TR/xmlschema-1/#element-documentation"/>
</xs:annotation>
<xs:complexType mixed="true">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:any processContents="lax"/>
</xs:sequence>
<xs:attribute name="source" type="xs:anyURI"/>
<xs:attribute ref="xml:lang"/>
</xs:complexType>
</xs:element>
Object[] | getChilds() - Returns the array of all child objects.
|
XmlLang | getLang() - Returns the documentation elements language.
|
XsAnyURI | getSource() - Returns the URI to read for the documentations contents.
|
String | getText() - Returns the embedded text.
|
boolean | isTextOnly() - Returns whether the documentation is simple.
|
void | setLang(XmlLang pLang) - Sets the documentation elements language.
|
void | setSource(XsAnyURI pSource) - Sets the URI to read for the documentations contents.
|
getChilds
public Object[] getChilds()
Returns the array of all child objects. Child objects may either
be Strings or DOM nodes.
getLang
public XmlLang getLang()
Returns the documentation elements language. Defaults to
null.
- The language abbreviation, for example "en".
getSource
public XsAnyURI getSource()
Returns the URI to read for the documentations contents.
Defaults to null.
getText
public String getText()
Returns the embedded text. The embedded text is specified as the
concatenation of all text nodes. Child elements, if any, are ignored.
isTextOnly
public boolean isTextOnly()
Returns whether the documentation is simple. In other words, whether
it consists of text only. If not, you should use
getChilds()
rather than
getText()
.
setLang
public void setLang(XmlLang pLang)
Sets the documentation elements language. Defaults to
null.
pLang
- The language abbreviation, for example "en".
setSource
public void setSource(XsAnyURI pSource)
Sets the URI to read for the documentations contents.
Defaults to null.