org.jomc.model

Class Dependency

java.lang.Object

org.jomc.model.ModelObject

org.jomc.model.SpecificationReference

org.jomc.model.Dependency

All Implemented Interfaces:

Cloneable, Inheritable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public class Dependency
extends SpecificationReference
implements Cloneable

Model of a dependency. The 'Dependency' type extends the 'SpecificationReference' type adding attributes 'implementationName', 'name', 'bound' and 'optional'. Attribute 'implementationName' holds an identifier selecting a single implementation from the set of implementations implementing the referenced specification. Attribute 'name' holds an identifier uniquely identifying the dependency in a set of dependencies. Attribute 'bound' flags the instances of the dependency bound to the declaring implementation. Attribute 'optional' flags a dependency optional. Dependencies, messages and properties set with a dependency override dependencies, messages and properties of the selected implementations.

Java class for Dependency complex type.

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

 <complexType name="Dependency">
   <complexContent>
     <extension base="{http://jomc.org/model}SpecificationReference">
       <sequence>
         <element ref="{http://jomc.org/model}dependencies" minOccurs="0"/>
         <element ref="{http://jomc.org/model}properties" minOccurs="0"/>
         <element ref="{http://jomc.org/model}messages" minOccurs="0"/>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="implementationName" type="{http://jomc.org/model}Identifier" />
       <attribute name="name" use="required" type="{http://jomc.org/model}Identifier" />
       <attribute name="bound" type="{http://jomc.org/model}Flag" default="true" />
       <attribute name="optional" type="{http://jomc.org/model}Flag" default="false" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Object>	any
protected Boolean	bound
protected Dependencies	dependencies
protected String	implementationName
protected Messages	messages
protected String	name
protected Boolean	optional
protected Properties	properties

Fields inherited from class org.jomc.model.SpecificationReference

_final, identifier, override, version

Fields inherited from class org.jomc.model.ModelObject

authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Dependency	clone() Creates and returns a deep copy of this object.
List<Object>	getAny() Gets the value of the any property.
JAXBElement	getAnyElement(String namespaceURI, String localPart) Deprecated. As of JOMC 1.1, please use method getAnyElement(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.
<T> 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.
List<JAXBElement>	getAnyElements(String namespaceURI, String localPart) Deprecated. As of JOMC 1.1, please use method getAnyElements(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.
<T> List<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.
Dependencies	getDependencies() Dependencies of this dependency or null.
String	getImplementationName() Name of the selected implementation of the specification of this dependency or null.
JavaIdentifier	getJavaConstantName() Gets the Java constant name of the dependency.
JavaIdentifier	getJavaGetterMethodName() Gets the Java getter method name of the dependency.
JavaIdentifier	getJavaSetterMethodName() Gets the Java setter method name of the dependency.
JavaIdentifier	getJavaVariableName() Gets the Java variable name of the dependency.
Messages	getMessages() Messages of this dependency or null.
String	getName() Name of this dependency.
Properties	getProperties() Properties of this dependency or null.
boolean	isBound() true, if instances of this dependency are bound to the declaring implementation.
boolean	isOptional() true, if this dependency is optional.
void	setBound(Boolean value) Sets the value of the bound property.
void	setDependencies(Dependencies value) Sets the value of the dependencies property.
void	setImplementationName(String value) Sets the value of the implementationName property.
void	setMessages(Messages value) Sets the value of the messages property.
void	setName(String value) Sets the value of the name property.
void	setOptional(Boolean value) Sets the value of the optional property.
void	setProperties(Properties value) Sets the value of the properties property.

Methods inherited from class org.jomc.model.SpecificationReference

getIdentifier, getVersion, isFinal, isOverride, setFinal, setIdentifier, setOverride, setVersion

Methods inherited from class org.jomc.model.ModelObject

getAnyElement, getAnyElement, getAnyElements, getAnyElements, getAnyObject, getAnyObjects, getAuthors, getCreateDate, getDocumentation, getModelVersion, isDeprecated, setAuthors, setCreateDate, setDeprecated, setDocumentation, setModelVersion

Methods inherited from class java.lang.Object

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

Field Detail

dependencies

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Dependencies dependencies

properties

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Properties properties

messages

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Messages messages

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected List<Object> any

implementationName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String implementationName

name

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected String name

bound

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Boolean bound

optional

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
protected Boolean optional

Constructor Detail

Dependency

public Dependency()

Creates a new Dependency instance.

Dependency

public Dependency(Dependency o)

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

Parameters:

o - The instance to copy.

Throws:

NullPointerException - if o is null.

Method Detail

getDependencies

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Dependencies getDependencies()

Dependencies of this dependency or null.

Returns:

possible object is Dependencies

setDependencies

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setDependencies(Dependencies value)

Sets the value of the dependencies property.

Parameters:

value - allowed object is Dependencies

getProperties

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Properties getProperties()

Properties of this dependency or null.

Returns:

possible object is Properties

setProperties

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setProperties(Properties value)

Sets the value of the properties property.

Parameters:

value - allowed object is Properties

getMessages

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Messages getMessages()

Messages of this dependency or null.

Returns:

possible object is Messages

setMessages

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setMessages(Messages value)

Sets the value of the messages property.

Parameters:

value - allowed object is Messages

getAny

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+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 Object Element

getImplementationName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getImplementationName()

Name of the selected implementation of the specification of this dependency or null.

Returns:

possible object is String

setImplementationName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setImplementationName(String value)

Sets the value of the implementationName property.

Parameters:

value - allowed object is String

getName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public String getName()

Name of this dependency.

Returns:

possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+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

isBound

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public boolean isBound()

true, if instances of this dependency are bound to the declaring implementation.

Returns:

possible object is Boolean

setBound

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public void setBound(Boolean value)

Sets the value of the bound property.

Parameters:

value - allowed object is Boolean

isOptional

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public boolean isOptional()

true, if this dependency is optional.

Returns:

possible object is Boolean

setOptional

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+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

clone

@Generated(value="com.sun.tools.xjc.Driver",
           date="2013-01-03T05:01:35+01:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-2")
public Dependency clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class SpecificationReference

Returns:

A deep copy of this object.

getJavaGetterMethodName

public JavaIdentifier getJavaGetterMethodName()
                                       throws ModelObjectException

Gets the Java getter method name of the dependency.

Returns:

The Java getter method name of the dependency.

Throws:

ModelObjectException - if compiling the name of the dependency to a JavaIdentifier fails.

Since:

1.4

See Also:

getName()

getJavaSetterMethodName

public JavaIdentifier getJavaSetterMethodName()
                                       throws ModelObjectException

Gets the Java setter method name of the dependency.

Returns:

The Java setter method name of the dependency.

Throws:

ModelObjectException - if compiling the name of the dependency to a JavaIdentifier fails.

Since:

1.4

See Also:

getName()

getJavaVariableName

public JavaIdentifier getJavaVariableName()
                                   throws ModelObjectException

Gets the Java variable name of the dependency.

Returns:

The Java variable name of the dependency.

Throws:

ModelObjectException - if compiling the name of the dependency to a JavaIdentifier fails.

Since:

1.4

See Also:

getName()

getJavaConstantName

public JavaIdentifier getJavaConstantName()
                                   throws ModelObjectException

Gets the Java constant name of the dependency.

Returns:

The Java constant name of the dependency.

Throws:

ModelObjectException - if compiling the name of the dependency to a JavaIdentifier fails.

Since:

1.4

See Also:

getName()

getAnyElement

@Deprecated
public JAXBElement getAnyElement(String namespaceURI,
                                   String localPart)

Deprecated. As of JOMC 1.1, please use method getAnyElement(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.

Gets a single JAXBElement matching a namespace URI and local part from the any property of the instance.

Parameters:

namespaceURI - The namespace URI of the JAXBElement to return.

localPart - The local part of the JAXBElement to return.

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 or localPart is null.

IllegalStateException - if the any property contains more than one matching element.

See Also:

ModelObject.getAnyElement(java.util.List, java.lang.String, java.lang.String)

getAnyElements

@Deprecated
public List<JAXBElement> getAnyElements(String namespaceURI,
                                          String localPart)

Deprecated. As of JOMC 1.1, please use method getAnyElements(java.lang.String, java.lang.String, java.lang.Class). This method will be removed in version 2.0.

Gets a list containing all JAXBElements matching a namespace URI and local part from the any property of the instance.

Parameters:

namespaceURI - The namespace URI of the JAXBElements to return.

localPart - The local part of the JAXBElements to return.

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 or localPart is null.

See Also:

ModelObject.getAnyElements(java.util.List, java.lang.String, java.lang.String)

getAnyElement

public <T> 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.

Since:

1.1

See Also:

ModelObject.getAnyElement(java.util.List, java.lang.String, java.lang.String, java.lang.Class)

getAnyElements

public <T> List<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.

Since:

1.1

See Also:

ModelObject.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:

ModelObject.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:

ModelObject.getAnyObjects(java.util.List, java.lang.Class)