Package org.javastro.ivoa.entities.vodml

Class Enumeration

java.lang.Object

org.javastro.ivoa.entities.vodml.ReferableElement

org.javastro.ivoa.entities.vodml.Type

org.javastro.ivoa.entities.vodml.ValueType

org.javastro.ivoa.entities.vodml.PrimitiveType

org.javastro.ivoa.entities.vodml.Enumeration

All Implemented Interfaces:

org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public class Enumeration
extends PrimitiveType
implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

A primitive type with a limited, discrete set of values. May explicitly extend a PrimitiveType. Its values must be compatible with that type then. TBD Should define what it might mean for an enumeraiton to extend another enumeration. Should it restrict the possible values further? Or should it add to the values? Or ...?

Java class for Enumeration complex type

.

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

 <complexType name="Enumeration">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/VODML/v1}PrimitiveType">
       <sequence>
         <element name="literal" type="{http://www.ivoa.net/xml/VODML/v1}EnumLiteral" maxOccurs="unbounded"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<EnumLiteral>	literals	TODO

Fields inherited from class org.javastro.ivoa.entities.vodml.Type

_abstract, _extends, constraints

Fields inherited from class org.javastro.ivoa.entities.vodml.ReferableElement

description, id, name, vodmlId

Constructor Summary

Constructors

Constructor	Description
Enumeration()	Default no-arg constructor
Enumeration(String vodmlId, String name, String description, String id, ElementRef _extends, List<Constraint> constraints, Boolean _abstract, List<EnumLiteral> literals)	Fully-initialising value constructor

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
StringBuilder	appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
Object	createNewInstance()
boolean	equals(Object object)
List<EnumLiteral>	getLiterals()	TODO Gets the value of the literals property.
int	hashCode()
void	mergeFrom(Object left, Object right)
void	mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
String	toString()
Enumeration	withAbstract(Boolean value)
Enumeration	withConstraints(Collection<Constraint> values)
Enumeration	withConstraints(Constraint... values)
Enumeration	withDescription(String value)
Enumeration	withExtends(ElementRef value)
Enumeration	withId(String value)
Enumeration	withLiterals(Collection<EnumLiteral> values)
Enumeration	withLiterals(EnumLiteral... values)
Enumeration	withName(String value)
Enumeration	withVodmlId(String value)

Methods inherited from class org.javastro.ivoa.entities.vodml.Type

getConstraints, getExtends, isAbstract, setAbstract, setExtends

Methods inherited from class org.javastro.ivoa.entities.vodml.ReferableElement

getDescription, getId, getName, getVodmlId, setDescription, setId, setName, setVodmlId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

literals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
protected List<EnumLiteral> literals

TODO

Constructor Details

Enumeration

public Enumeration()

Default no-arg constructor

Enumeration

public Enumeration(String vodmlId,
 String name,
 String description,
 String id,
 ElementRef _extends,
 List<Constraint> constraints,
 Boolean _abstract,
 List<EnumLiteral> literals)

Fully-initialising value constructor

Method Details

getLiterals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public List<EnumLiteral> getLiterals()

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

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

 getLiterals().add(newItem);
 

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

Returns:

The value of the literals property.

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public boolean equals(Object object)

Overrides:

equals in class PrimitiveType

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public int hashCode()

Overrides:

hashCode in class PrimitiveType

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public String toString()

Overrides:

toString in class PrimitiveType

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

append in interface org.jvnet.jaxb.lang.ToString

Overrides:

append in class PrimitiveType

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb.lang.ToStringStrategy strategy)

Specified by:

appendFields in interface org.jvnet.jaxb.lang.ToString

Overrides:

appendFields in class PrimitiveType

withLiterals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Enumeration withLiterals(EnumLiteral... values)

withLiterals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Enumeration withLiterals(Collection<EnumLiteral> values)

withExtends

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Enumeration withExtends(ElementRef value)

Overrides:

withExtends in class PrimitiveType

withConstraints

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Enumeration withConstraints(Constraint... values)

Overrides:

withConstraints in class PrimitiveType

withConstraints

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Enumeration withConstraints(Collection<Constraint> values)

Overrides:

withConstraints in class PrimitiveType

withAbstract

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Enumeration withAbstract(Boolean value)

Overrides:

withAbstract in class PrimitiveType

withVodmlId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Enumeration withVodmlId(String value)

Overrides:

withVodmlId in class PrimitiveType

withName

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Enumeration withName(String value)

Overrides:

withName in class PrimitiveType

withDescription

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Enumeration withDescription(String value)

Overrides:

withDescription in class PrimitiveType

withId

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Enumeration withId(String value)

Overrides:

withId in class PrimitiveType

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

mergeFrom in class PrimitiveType

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator,
 org.jvnet.jaxb.locator.ObjectLocator rightLocator,
 Object left,
 Object right,
 org.jvnet.jaxb.lang.MergeStrategy strategy)

Specified by:

mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

mergeFrom in class PrimitiveType

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2024-08-01T13:15:43+01:00")
public Object createNewInstance()

Specified by:

createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom

Overrides:

createNewInstance in class PrimitiveType