org.jomc.model
Class Dependency

Package class diagram package Dependency
java.lang.Object
  extended by org.jomc.model.ModelObject
      extended by org.jomc.model.SpecificationReference
          extended by org.jomc.model.Dependency
All Implemented Interfaces:
Cloneable

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public class Dependency
extends SpecificationReference
implements Cloneable

Model of a dependency.

A dependency consists of a name uniquely identifying the dependency in a set of dependencies and pairs a specification with corresponding implementations from a set of available implementations. Properties set with a dependency override properties of the dependencies specification. The bound flag indicates if the instance of the dependency is bound to the declaring implementation. The optional flag indicates an optional dependency.


Field Summary
protected  List<Object> any
           
protected  Boolean bound
           
protected  String implementationName
           
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, modelVersion
 
Constructor Summary
Dependency()
          Creates a new Dependency instance.
Dependency(Dependency o)
          Creates a new Dependency instance by deeply copying a given Dependency instance.
 
Method Summary
 Dependency clone()
          Creates and returns a deep copy of this object.
 List<Object> getAny()
          Gets the value of the any property.
 String getImplementationName()
          Name of the referenced implementation of the specification or null.
 String getName()
          Name of this dependency.
 Properties getProperties()
          Properties of this dependency or null.
 boolean isBound()
          True, if this dependency is bound to its declaring instance; false, if not.
 boolean isOptional()
          True, if this dependency is optional; false, if not.
 void setBound(Boolean value)
          Sets the value of the bound property.
 void setImplementationName(String value)
          Sets the value of the implementationName 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
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

properties

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected Properties properties

any

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected List<Object> any

implementationName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected String implementationName

name

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected String name

bound

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
protected Boolean bound

optional

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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

getProperties

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public Properties getProperties()
Properties of this dependency or null.

Returns:
possible object is Properties

setProperties

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public void setProperties(Properties value)
Sets the value of the properties property.

Parameters:
value - allowed object is Properties

getAny

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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


getImplementationName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public String getImplementationName()
Name of the referenced implementation of the specification or null. If not set, the specification's multiplicity determines the implementation(s) of the dependency.

Returns:
possible object is String

setImplementationName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public String getName()
Name of this dependency.

Returns:
possible object is String

setName

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public boolean isBound()
True, if this dependency is bound to its declaring instance; false, if not.

Returns:
possible object is Boolean

setBound

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public boolean isOptional()
True, if this dependency is optional; false, if not.

Returns:
possible object is Boolean

setOptional

@Generated(value="com.sun.tools.xjc.Driver",
           date="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
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="2009-11-18T06:28:36+00:00",
           comments="JAXB RI vhudson-jaxb-ri-2.1-833")
public Dependency clone()
Creates and returns a deep copy of this object.

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


Copyright © 2005-2009 The JOMC Project. All Rights Reserved.