|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jomc.model.ModelObject
org.jomc.model.Instance
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public class Instance
Model of an instance. The 'Instance' type defines attributes 'identifier', 'name', 'class' and 'stateless'. Attribute 'identifier' holds an identifier uniquely identifying the instance in a set of instances. Attribute 'name' holds an identifier uniquely identifying the implementation of the specifications implemented by an instance. Attribute 'class' holds an identifier of the class of an instance. Attribute 'stateless' flags an instance stateless. An instance is build from implementations. An implementation declaring a location declares its instance located outside the scope of the model. An implementation not delcaring a class is only available during implementation inheritance processing. No instance is build from such implementations.
Java class for Instance complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="Instance"> <complexContent> <extension base="{http://jomc.org/model}ModelObject"> <sequence> <element ref="{http://jomc.org/model}specifications" minOccurs="0"/> <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="identifier" use="required" type="{http://jomc.org/model}Identifier" /> <attribute name="name" use="required" type="{http://jomc.org/model}Identifier" /> <attribute name="class" use="required" type="{http://jomc.org/model}Identifier" /> <attribute name="stateless" type="{http://jomc.org/model}Flag" default="false" /> </extension> </complexContent> </complexType>
Field Summary | |
---|---|
protected List<Object> |
any
|
protected String |
clazz
|
protected Dependencies |
dependencies
|
protected String |
identifier
|
protected Messages |
messages
|
protected String |
name
|
protected Properties |
properties
|
protected Specifications |
specifications
|
protected Boolean |
stateless
|
Fields inherited from class org.jomc.model.ModelObject |
---|
authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion |
Constructor Summary | |
---|---|
Instance()
Creates a new Instance instance. |
|
Instance(Instance o)
Creates a new Instance instance by deeply copying a given Instance instance. |
Method Summary | ||
---|---|---|
Instance |
clone()
Creates and returns a deep copy of this object. |
|
List<Object> |
getAny()
Gets the value of the any property. |
|
javax.xml.bind.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. |
|
|
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<javax.xml.bind.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. |
|
|
getAnyElements(String namespaceURI,
String localPart,
Class<T> type)
Gets a list containing all JAXBElement s matching a namespace URI and local part from the any
property of the instance. |
|
|
getAnyObject(Class<T> clazz)
Gets a single object matching a given class from the any property of the instance. |
|
|
getAnyObjects(Class<T> clazz)
Gets a list containing all objects matching a given class from the any property of the instance. |
|
String |
getClazz()
The identifier of the class of this instance. |
|
Dependencies |
getDependencies()
Dependencies of this instance or null . |
|
Map<String,Object> |
getDependencyObjects()
Gets a mapping of dependency names to objects bound to the instance. |
|
String |
getIdentifier()
The identifier of this instance. |
|
Class<?> |
getJavaClass(ClassLoader classLoader)
Gets the Java class of the instance for a given class loader. |
|
Class<?>[] |
getJavaClasses(ClassLoader classLoader)
Gets the Java classes of all specifications of the instance for a given class loader. |
|
Constructor<?> |
getJavaConstructor(ClassLoader classLoader)
Gets the Java constructor to use for creating objects of the instance. |
|
Method |
getJavaFactoryMethod(ClassLoader classLoader)
Gets the Java method to use for creating objects of the instance. |
|
String |
getJavaFactoryMethodName()
Gets the name of the Java method to use for creating objects of the instance. |
|
Class<?> |
getJavaProxyClass(ClassLoader classLoader)
Gets the Java proxy class for a given class loader. |
|
Map<String,Map<Locale,MessageFormat>> |
getMessageObjects()
Gets a mapping of message names to a mapping of locales to message format objects bound to the instance. |
|
Messages |
getMessages()
Messages of this instance or null . |
|
String |
getName()
The name of the implementation of the specifications implemented by this instance. |
|
Properties |
getProperties()
Properties of this instance or null . |
|
Map<String,Object> |
getPropertyObjects()
Gets a mapping of property names to objects bound to the instance. |
|
Specifications |
getSpecifications()
Specifications implemented by this instance or null . |
|
boolean |
isJavaClassAssignable(ClassLoader classLoader)
Gets a flag indicating the Java class of the instance is assignable to all Java classes of all specifications of the instance. |
|
boolean |
isStateless()
true , if this instance does not retain state across operations. |
|
void |
setClazz(String value)
Sets the value of the clazz property. |
|
void |
setDependencies(Dependencies value)
Sets the value of the dependencies property. |
|
void |
setIdentifier(String value)
Sets the value of the identifier property. |
|
void |
setMessages(Messages value)
Sets the value of the messages property. |
|
void |
setName(String value)
Sets the value of the name property. |
|
void |
setProperties(Properties value)
Sets the value of the properties property. |
|
void |
setSpecifications(Specifications value)
Sets the value of the specifications property. |
|
void |
setStateless(Boolean value)
Sets the value of the stateless property. |
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 |
---|
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") protected Specifications specifications
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") protected Dependencies dependencies
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") protected Properties properties
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") protected Messages messages
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") protected List<Object> any
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") protected String identifier
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") protected String name
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") protected String clazz
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") protected Boolean stateless
Constructor Detail |
---|
public Instance()
Instance
instance.
public Instance(Instance o)
Instance
instance by deeply copying a given Instance
instance.
o
- The instance to copy.
NullPointerException
- if o
is null
.Method Detail |
---|
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public Specifications getSpecifications()
null
.
Specifications
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public void setSpecifications(Specifications value)
value
- allowed object is
Specifications
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public Dependencies getDependencies()
null
.
Dependencies
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public void setDependencies(Dependencies value)
value
- allowed object is
Dependencies
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public Properties getProperties()
null
.
Properties
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public void setProperties(Properties value)
value
- allowed object is
Properties
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public Messages getMessages()
null
.
Messages
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public void setMessages(Messages value)
value
- allowed object is
Messages
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public List<Object> getAny()
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
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public String getIdentifier()
String
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public void setIdentifier(String value)
value
- allowed object is
String
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public String getName()
String
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public void setName(String value)
value
- allowed object is
String
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public String getClazz()
String
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public void setClazz(String value)
value
- allowed object is
String
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public boolean isStateless()
true
, if this instance does not retain state across operations.
Boolean
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public void setStateless(Boolean value)
value
- allowed object is
Boolean
@Generated(value="com.sun.tools.xjc.Driver", date="2012-03-14T10:22:27+01:00", comments="JAXB RI vhudson-jaxb-ri-2.1-2") public Instance clone()
clone
in class ModelObject
public Map<String,Object> getDependencyObjects()
This method returns a reference to the live map, not a snapshot. Any modification you make to the returned map will be present inside the object.
public Map<String,Map<Locale,MessageFormat>> getMessageObjects()
This method returns a reference to the live map, not a snapshot. Any modification you make to the returned map will be present inside the object.
public Map<String,Object> getPropertyObjects()
This method returns a reference to the live map, not a snapshot. Any modification you make to the returned map will be present inside the object.
public Class<?> getJavaClass(ClassLoader classLoader) throws ClassNotFoundException
classLoader
- The class loader to get the Java class from or null
, to get the Java class from the
platform's bootstrap class loader.
ClassNotFoundException
- if the Java class is not found.getClazz()
public Class<?>[] getJavaClasses(ClassLoader classLoader) throws ClassNotFoundException
classLoader
- The class loader to get the Java classes from or null
, to get the Java classes from
the platform's bootstrap class loader.
ClassNotFoundException
- if a Java class is not found.getSpecifications()
,
Specification.getClazz()
public Constructor<?> getJavaConstructor(ClassLoader classLoader) throws ClassNotFoundException
classLoader
- The class loader to get the Java class from or null
, to get the Java class from the
platform's bootstrap class loader.
null
, if that class
does not declare such a constructor, is abstract or is not public.
ClassNotFoundException
- if the Java class is not found.getJavaClass(java.lang.ClassLoader)
public String getJavaFactoryMethodName()
null
, if no such
method name is supported.getName()
public Method getJavaFactoryMethod(ClassLoader classLoader) throws ClassNotFoundException
classLoader
- The class loader to get the Java class from or null
, to get the Java class from the
platform's bootstrap class loader.
null
, if that class does not declare such a method.
ClassNotFoundException
- if the Java class is not found.getJavaClass(java.lang.ClassLoader)
,
getJavaFactoryMethodName()
public boolean isJavaClassAssignable(ClassLoader classLoader) throws ClassNotFoundException
classLoader
- The class loader to get the Java classes from or null
, to get the Java classes from
the platform's bootstrap class loader.
true
, if the Java class of the instance is assignable to all Java classes of all specifications
of the instance; false
, if the Java class of the instance is not assignable to all Java classes of all
specifications of the instance.
ClassNotFoundException
- if a Java class is not found.getJavaClass(java.lang.ClassLoader)
,
getJavaClasses(java.lang.ClassLoader)
public Class<?> getJavaProxyClass(ClassLoader classLoader) throws ClassNotFoundException
classLoader
- The class loader to get the Java proxy class from or null
, to get the Java proxy class
from the platform's bootstrap class loader.
classLoader
or null
, if the instance does not support a Java
proxy class.
ClassNotFoundException
- if a Java class is not found.getJavaClasses(java.lang.ClassLoader)
@Deprecated public javax.xml.bind.JAXBElement getAnyElement(String namespaceURI, String localPart)
getAnyElement(java.lang.String, java.lang.String, java.lang.Class)
.
This method will be removed in version 2.0.
JAXBElement
matching a namespace URI and local part from the any
property of the
instance.
namespaceURI
- The namespace URI of the JAXBElement
to return.localPart
- The local part of the JAXBElement
to return.
JAXBElement
matching namespaceURI
and localPart
from the any
property
of the instance or null
, if no such element is found.
NullPointerException
- if namespaceURI
or localPart
is null
.
IllegalStateException
- if the any
property contains more than one matching element.ModelObject.getAnyElement(java.util.List, java.lang.String, java.lang.String)
@Deprecated public List<javax.xml.bind.JAXBElement> getAnyElements(String namespaceURI, String localPart)
getAnyElements(java.lang.String, java.lang.String, java.lang.Class)
.
This method will be removed in version 2.0.
JAXBElement
s matching a namespace URI and local part from the any
property of the instance.
namespaceURI
- The namespace URI of the JAXBElement
s to return.localPart
- The local part of the JAXBElement
s to return.
JAXBElement
s matching namespaceURI
and localPart
from
the any
property of the instance - an empty list if no such elements are found.
NullPointerException
- if namespaceURI
or localPart
is null
.ModelObject.getAnyElements(java.util.List, java.lang.String, java.lang.String)
public <T> javax.xml.bind.JAXBElement<T> getAnyElement(String namespaceURI, String localPart, Class<T> type)
JAXBElement
matching a namespace URI and local part from the any
property of the
instance.
T
- The type the element is bound to.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.
JAXBElement
matching namespaceURI
and localPart
from the any
property
of the instance or null
, if no such element is found.
NullPointerException
- if namespaceURI
, localPart
or type
is null
.
IllegalStateException
- if the any
property contains more than one matching element.ModelObject.getAnyElement(java.util.List, java.lang.String, java.lang.String, java.lang.Class)
public <T> List<javax.xml.bind.JAXBElement<T>> getAnyElements(String namespaceURI, String localPart, Class<T> type)
JAXBElement
s matching a namespace URI and local part from the any
property of the instance.
T
- The type the elements are bound to.namespaceURI
- The namespace URI of the JAXBElement
s to return.localPart
- The local part of the JAXBElement
s to return.type
- The class of the type the elements are bound to.
JAXBElement
s matching namespaceURI
and localPart
from
the any
property of the instance - an empty list if no such elements are found.
NullPointerException
- if namespaceURI
, localPart
or type
is null
.ModelObject.getAnyElements(java.util.List, java.lang.String, java.lang.String, java.lang.Class)
public <T> T getAnyObject(Class<T> clazz)
any
property of the instance.
T
- The type of the object to return.clazz
- The class to return an instance of.
clazz
from the any
property of the instance or null
if no such
instance is found.
NullPointerException
- if clazz
is null
.
IllegalStateException
- if the any
property contains more than one matching object.ModelObject.getAnyObject(java.util.List, java.lang.Class)
public <T> List<T> getAnyObjects(Class<T> clazz)
any
property of the instance.
T
- The type of the objects to return.clazz
- The class to return all instances of.
clazz
from the any
property of the instance -
an empty list if no such objects are found.
NullPointerException
- if clazz
is null
.ModelObject.getAnyObjects(java.util.List, java.lang.Class)
|
||||||||||
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. |