Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jomc.tools.model
Class SourceSectionType

Package class diagram package SourceSectionType
java.lang.Object
  extended by org.jomc.tools.model.ToolsType
      extended by org.jomc.tools.model.SourceSectionType
All Implemented Interfaces:
Cloneable
@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class SourceSectionType
extends ToolsType
implements Cloneable

Model of a source code file section.

Java class for SourceSectionType complex type.

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

 <complexType name="SourceSectionType">
   <complexContent>
     <extension base="{http://jomc.org/tools/model}ToolsType">
       <sequence>
         <element ref="{http://jomc.org/tools/model}source-sections" minOccurs="0"/>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="head-template" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="tail-template" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="indentationLevel" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
       <attribute name="optional" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="editable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </extension>
   </complexContent>
 </complexType>

Field Summary
protected  List<Object> any
           
protected  Boolean editable
           
protected  String headTemplate
           
protected  Integer indentationLevel
           
protected  String name
           
protected  Boolean optional
           
protected  SourceSectionsType sourceSections
           
protected  String tailTemplate
           
 
Fields inherited from class org.jomc.tools.model.ToolsType
modelVersion
 
Constructor Summary
SourceSectionType()
          Creates a new SourceSectionType instance.
SourceSectionType(SourceSectionType o)
          Creates a new SourceSectionType instance by deeply copying a given SourceSectionType instance.
 
Method Summary
 SourceSectionType clone()
          Creates and returns a deep copy of this object.
 List<Object> getAny()
          Gets the value of the any property.
<T> javax.xml.bind.JAXBElement<T>
getAnyElement(String namespaceURI, String localPart, Class<T> type)
          Gets a single JAXBElement matching a namespace URI and local part from the any property of the instance.
<T> List<javax.xml.bind.JAXBElement<T>>
getAnyElements(String namespaceURI, String localPart, Class<T> type)
          Gets a list containing all JAXBElements matching a namespace URI and local part from the any property of the instance.
<T> T
getAnyObject(Class<T> clazz)
          Gets a single object matching a given class from the any property of the instance.
<T> List<T>
getAnyObjects(Class<T> clazz)
          Gets a list containing all objects matching a given class from the any property of the instance.
 String getHeadTemplate()
          Gets the value of the headTemplate property.
 int getIndentationLevel()
          Gets the value of the indentationLevel property.
 String getName()
          Gets the value of the name property.
 SourceSectionsType getSourceSections()
          Child sections of the section.
 String getTailTemplate()
          Gets the value of the tailTemplate property.
 boolean isEditable()
          Gets the value of the editable property.
 boolean isOptional()
          Gets the value of the optional property.
 void setEditable(Boolean value)
          Sets the value of the editable property.
 void setHeadTemplate(String value)
          Sets the value of the headTemplate property.
 void setIndentationLevel(Integer value)
          Sets the value of the indentationLevel property.
 void setName(String value)
          Sets the value of the name property.
 void setOptional(Boolean value)
          Sets the value of the optional property.
 void setSourceSections(SourceSectionsType value)
          Sets the value of the sourceSections property.
 void setTailTemplate(String value)
          Sets the value of the tailTemplate property.
 
Methods inherited from class org.jomc.tools.model.ToolsType
getAnyElement, getAnyElements, getAnyObject, getAnyObjects, getModelVersion, setModelVersion
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

sourceSections

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected SourceSectionsType sourceSections

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected List<Object> any

name

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String name

headTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String headTemplate

tailTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String tailTemplate

indentationLevel

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Integer indentationLevel

optional

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Boolean optional

editable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Boolean editable
Constructor Detail

SourceSectionType

public SourceSectionType()
Creates a new SourceSectionType instance.

SourceSectionType

public SourceSectionType(SourceSectionType o)
Creates a new SourceSectionType instance by deeply copying a given SourceSectionType instance.

Parameters:
o - The instance to copy.
Throws:
NullPointerException - if o is null.
Method Detail

getSourceSections

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public SourceSectionsType getSourceSections()
Child sections of the section.

Returns:
possible object is SourceSectionsType

setSourceSections

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setSourceSections(SourceSectionsType value)
Sets the value of the sourceSections property.

Parameters:
value - allowed object is SourceSectionsType

getAny

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public List<Object> getAny()
Gets the value of the any property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the any property.

For example, to add a new item, do as follows: 

    getAny().add(newItem);

Objects of the following type(s) are allowed in the list Element Object

getName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getName()
Gets the value of the name property.

Returns:
possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setName(String value)
Sets the value of the name property.

Parameters:
value - allowed object is String

getHeadTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getHeadTemplate()
Gets the value of the headTemplate property.

Returns:
possible object is String

setHeadTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setHeadTemplate(String value)
Sets the value of the headTemplate property.

Parameters:
value - allowed object is String

getTailTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getTailTemplate()
Gets the value of the tailTemplate property.

Returns:
possible object is String

setTailTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setTailTemplate(String value)
Sets the value of the tailTemplate property.

Parameters:
value - allowed object is String

getIndentationLevel

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public int getIndentationLevel()
Gets the value of the indentationLevel property.

Returns:
possible object is Integer

setIndentationLevel

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setIndentationLevel(Integer value)
Sets the value of the indentationLevel property.

Parameters:
value - allowed object is Integer

isOptional

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public boolean isOptional()
Gets the value of the optional property.

Returns:
possible object is Boolean

setOptional

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setOptional(Boolean value)
Sets the value of the optional property.

Parameters:
value - allowed object is Boolean

isEditable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public boolean isEditable()
Gets the value of the editable property.

Returns:
possible object is Boolean

setEditable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setEditable(Boolean value)
Sets the value of the editable property.

Parameters:
value - allowed object is Boolean

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2012-02-17T01:46:51+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public SourceSectionType clone()
Creates and returns a deep copy of this object.

Overrides:
clone in class ToolsType
Returns:
A deep copy of this object.

getAnyElement

public <T> javax.xml.bind.JAXBElement<T> getAnyElement(String namespaceURI,
                                                       String localPart,
                                                       Class<T> type)
Gets a single JAXBElement matching a namespace URI and local part from the any property of the instance.

Type Parameters:
T - The type the element is bound to.
Parameters:
namespaceURI - The namespace URI of the JAXBElement to return.
localPart - The local part of the JAXBElement to return.
type - The class of the type the element is bound to.
Returns:
The JAXBElement matching namespaceURI and localPart from the any property of the instance or null, if no such element is found.
Throws:
NullPointerException - if namespaceURI, localPart or type is null.
IllegalStateException - if the any property contains more than one matching element.
See Also:
ToolsType.getAnyElement(java.util.List, java.lang.String, java.lang.String, java.lang.Class)

getAnyElements

public <T> List<javax.xml.bind.JAXBElement<T>> getAnyElements(String namespaceURI,
                                                              String localPart,
                                                              Class<T> type)
Gets a list containing all JAXBElements matching a namespace URI and local part from the any property of the instance.

Type Parameters:
T - The type the elements are bound to.
Parameters:
namespaceURI - The namespace URI of the JAXBElements to return.
localPart - The local part of the JAXBElements to return.
type - The class of the type the elements are bound to.
Returns:
An unmodifiable list of all JAXBElements matching namespaceURI and localPart from the any property of the instance - an empty list if no such elements are found.
Throws:
NullPointerException - if namespaceURI, localPart or type is null.
See Also:
ToolsType.getAnyElements(java.util.List, java.lang.String, java.lang.String, java.lang.Class)

getAnyObject

public <T> T getAnyObject(Class<T> clazz)
Gets a single object matching a given class from the any property of the instance.

Type Parameters:
T - The type of the object to return.
Parameters:
clazz - The class to return an instance of.
Returns:
The instance of clazz from the any property of the instance or null, if no such instance is found.
Throws:
NullPointerException - if clazz is null.
IllegalStateException - if the any property contains more than one matching object.
See Also:
ToolsType.getAnyObject(java.util.List, java.lang.Class)

getAnyObjects

public <T> List<T> getAnyObjects(Class<T> clazz)
Gets a list containing all objects matching a given class from the any property of the instance.

Type Parameters:
T - The type of the objects to return.
Parameters:
clazz - The class to return all instances of.
Returns:
An unmodifiable list of all instances of clazz from the any property of the instance - an empty list if no such objects are found.
Throws:
NullPointerException - if clazz is null.
See Also:
ToolsType.getAnyObjects(java.util.List, java.lang.Class)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2005-2012 The JOMC Project. All Rights Reserved.Get JOMC at SourceForge.net. Fast, secure and Free Open Source software downloads
Please note that this documentation is maintained by non-native english speaking authors. As such, you may encounter phrases or wordings which seem imprecise or may even have a totally different meaning to native english speaking readers than what the individual author was trying to express. If you are a native english speaking reader and find any such phrases or wordings we kindly ask you to send an email to the corresponding author and help us improve this documentation in order to avoid misunderstandings. You will find the authors' email addresses at the top of each class. Please accept our apologies for any inconvenience caused.