org.jomc.tools.model

Class SourceFileType

java.lang.Object

org.jomc.tools.model.ToolsType

org.jomc.tools.model.SourceFileType

All Implemented Interfaces:

Cloneable, org.jomc.model.Inheritable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class SourceFileType
extends ToolsType
implements Cloneable, org.jomc.model.Inheritable

Model of a source code file.

Java class for SourceFileType complex type.

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	_final
protected List<Object>	any
protected String	headComment
protected String	identifier
protected String	location
protected Boolean	override
protected SourceSectionsType	sourceSections
protected String	tailComment
protected String	template
protected List<TemplateParameterType>	templateParameter

Fields inherited from class org.jomc.tools.model.ToolsType

modelVersion

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
SourceFileType	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	getHeadComment() Gets the value of the headComment property.
String	getIdentifier() Gets the value of the identifier property.
String	getLocation() Gets the value of the location property.
SourceSectionsType	getSourceSections() Sections of the source file.
String	getTailComment() Gets the value of the tailComment property.
String	getTemplate() Gets the value of the template property.
List<TemplateParameterType>	getTemplateParameter() Gets the value of the templateParameter property.
TemplateParameterType	getTemplateParameter(String name) Gets a template parameter for a given name from the list of template parameters.
boolean	isFinal() Gets the value of the final property.
boolean	isOverride() Gets the value of the override property.
void	setFinal(Boolean value) Sets the value of the final property.
void	setHeadComment(String value) Sets the value of the headComment property.
void	setIdentifier(String value) Sets the value of the identifier property.
void	setLocation(String value) Sets the value of the location property.
void	setOverride(Boolean value) Sets the value of the override property.
void	setSourceSections(SourceSectionsType value) Sets the value of the sourceSections property.
void	setTailComment(String value) Sets the value of the tailComment property.
void	setTemplate(String value) Sets the value of the template 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="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected SourceSectionsType sourceSections

templateParameter

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected List<TemplateParameterType> templateParameter

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected List<Object> any

identifier

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String identifier

location

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String location

template

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String template

headComment

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String headComment

tailComment

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String tailComment

_final

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Boolean _final

override

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Boolean override

Constructor Detail

SourceFileType

public SourceFileType()

Creates a new SourceFileType instance.

SourceFileType

public SourceFileType(SourceFileType o)

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

Parameters:

o - The instance to copy.

Throws:

NullPointerException - if o is null.

Method Detail

getSourceSections

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public SourceSectionsType getSourceSections()

Sections of the source file.

Returns:

possible object is SourceSectionsType

setSourceSections

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02: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

getTemplateParameter

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public List<TemplateParameterType> getTemplateParameter()

Gets the value of the templateParameter 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 templateParameter property.

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

    getTemplateParameter().add(newItem);
 

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

getAny

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02: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 Object Element

getIdentifier

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getIdentifier()

Gets the value of the identifier property.

Returns:

possible object is String

setIdentifier

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setIdentifier(String value)

Sets the value of the identifier property.

Parameters:

value - allowed object is String

getLocation

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getLocation()

Gets the value of the location property.

Returns:

possible object is String

setLocation

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setLocation(String value)

Sets the value of the location property.

Parameters:

value - allowed object is String

getTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getTemplate()

Gets the value of the template property.

Returns:

possible object is String

setTemplate

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setTemplate(String value)

Sets the value of the template property.

Parameters:

value - allowed object is String

getHeadComment

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getHeadComment()

Gets the value of the headComment property.

Returns:

possible object is String

setHeadComment

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setHeadComment(String value)

Sets the value of the headComment property.

Parameters:

value - allowed object is String

getTailComment

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getTailComment()

Gets the value of the tailComment property.

Returns:

possible object is String

setTailComment

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setTailComment(String value)

Sets the value of the tailComment property.

Parameters:

value - allowed object is String

isFinal

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public boolean isFinal()

Gets the value of the final property.

Specified by:

isFinal in interface org.jomc.model.Inheritable

Returns:

possible object is Boolean

setFinal

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setFinal(Boolean value)

Sets the value of the final property.

Parameters:

value - allowed object is Boolean

isOverride

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public boolean isOverride()

Gets the value of the override property.

Specified by:

isOverride in interface org.jomc.model.Inheritable

Returns:

possible object is Boolean

setOverride

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setOverride(Boolean value)

Sets the value of the override property.

Parameters:

value - allowed object is Boolean

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2016-09-10T12:10:26+02:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public SourceFileType 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)

getTemplateParameter

public TemplateParameterType getTemplateParameter(String name)

Gets a template parameter for a given name from the list of template parameters.

Parameters:

name - The name of the template parameter to return.

Returns:

The first matching template parameter or null, if no such template parameter is found.

Throws:

NullPointerException - if name is null.

Since:

1.6

See Also:

getTemplateParameter(), TemplateParameterType.getName()