Package org.javastro.ivoa.entities.resource.dataservice

Class InputParam

java.lang.Object

org.javastro.ivoa.entities.resource.dataservice.BaseParam

org.javastro.ivoa.entities.resource.dataservice.InputParam

All Implemented Interfaces:

com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, Cloneable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public class InputParam
extends BaseParam
implements Cloneable, com.kscs.util.jaxb.Copyable, com.kscs.util.jaxb.PartialCopyable, org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString

The allowed data type names do not imply a size or precise format. This type is intended to be sufficient for describing an input parameter to a simple REST service or a function written in a weakly-typed language.

Java class for InputParam complex type

.

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

 <complexType name="InputParam">
   <complexContent>
     <extension base="{http://www.ivoa.net/xml/VODataService/v1.1}BaseParam">
       <sequence>
         <element name="dataType" type="{http://www.ivoa.net/xml/VODataService/v1.1}SimpleDataType" minOccurs="0"/>
       </sequence>
       <attribute name="use" type="{http://www.ivoa.net/xml/VODataService/v1.1}ParamUse" default="optional" />
       <attribute name="std" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <anyAttribute namespace='##other'/>
     </extension>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InputParam.Builder<_B>
class	InputParam.Modifier
static class	InputParam.PropInfo
static class	InputParam.Select
static class	InputParam.Selector<TRoot extends com.kscs.util.jaxb.Selector<TRoot,?>,TParent>

Field Summary

Fields

Modifier and Type	Field	Description
protected SimpleDataType	dataType	A type of data contained in the parameter
protected Boolean	std	If true, the meaning and behavior of this parameter is reserved and defined by a standard interface.
protected ParamUse	use	An indication of whether this parameter is required to be provided for the application or service to work properly.

Fields inherited from class org.javastro.ivoa.entities.resource.dataservice.BaseParam

__cachedModifier__, description, name, ucd, unit, utype

Constructor Summary

Constructors

Constructor	Description
InputParam()	Default no-arg constructor
InputParam(String name, String description, String unit, String ucd, String utype, Map<QName,String> otherAttributes, SimpleDataType dataType, ParamUse use, Boolean std)	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)
static InputParam.Builder<Void>	builder()
InputParam	clone()
InputParam	copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)
static InputParam.Builder<Void>	copyExcept(BaseParam _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static InputParam.Builder<Void>	copyExcept(InputParam _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> InputParam.Builder<_B>	copyOf(BaseParam _other)
static <_B> InputParam.Builder<_B>	copyOf(BaseParam _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static <_B> InputParam.Builder<_B>	copyOf(InputParam _other)
static <_B> InputParam.Builder<_B>	copyOf(InputParam _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
InputParam	copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)
static InputParam.Builder<Void>	copyOnly(BaseParam _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static InputParam.Builder<Void>	copyOnly(InputParam _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(InputParam.Builder<_B> _other)	Copies all state of this object to a builder.
<_B> void	copyTo(InputParam.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)	Copies all state of this object to a builder.
InputParam	createCopy()
InputParam	createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Object	createNewInstance()
boolean	equals(Object object)
SimpleDataType	getDataType()	A type of data contained in the parameter
ParamUse	getUse()	An indication of whether this parameter is required to be provided for the application or service to work properly.
int	hashCode()
boolean	isStd()	If true, the meaning and behavior of this parameter is reserved and defined by a standard interface.
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)
InputParam.Modifier	modifier()
InputParam.Builder<Void>	newCopyBuilder()
<_B> InputParam.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> InputParam.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
InputParam.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
void	setDataType(SimpleDataType value)	Sets the value of the dataType property.
void	setStd(Boolean value)	Sets the value of the std property.
void	setUse(ParamUse value)	Sets the value of the use property.
String	toString()
InputParam	visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Methods inherited from class org.javastro.ivoa.entities.resource.dataservice.BaseParam

copyTo, copyTo, getDescription, getName, getOtherAttributes, getUcd, getUnit, getUtype, setDescription, setName, setUcd, setUnit, setUtype

Methods inherited from class java.lang.Object

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

Field Details

dataType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
protected SimpleDataType dataType

A type of data contained in the parameter

use

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
protected ParamUse use

An indication of whether this parameter is required to be provided for the application or service to work properly.

std

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
protected Boolean std

If true, the meaning and behavior of this parameter is reserved and defined by a standard interface. If false, it represents an implementation-specific parameter that effectively extends the behavior of the service or application.

Constructor Details

InputParam

public InputParam()

Default no-arg constructor

InputParam

public InputParam(String name,
 String description,
 String unit,
 String ucd,
 String utype,
 Map<QName,String> otherAttributes,
 SimpleDataType dataType,
 ParamUse use,
 Boolean std)

Fully-initialising value constructor

Method Details

getDataType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public SimpleDataType getDataType()

A type of data contained in the parameter

Returns:

possible object is SimpleDataType

setDataType

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public void setDataType(SimpleDataType value)

Sets the value of the dataType property.

Parameters:

value - allowed object is SimpleDataType

See Also:

• getDataType()

getUse

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public ParamUse getUse()

An indication of whether this parameter is required to be provided for the application or service to work properly.

Returns:

possible object is ParamUse

setUse

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public void setUse(ParamUse value)

Sets the value of the use property.

Parameters:

value - allowed object is ParamUse

See Also:

• getUse()

isStd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public boolean isStd()

If true, the meaning and behavior of this parameter is reserved and defined by a standard interface. If false, it represents an implementation-specific parameter that effectively extends the behavior of the service or application.

Returns:

possible object is Boolean

setStd

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public void setStd(Boolean value)

Sets the value of the std property.

Parameters:

value - allowed object is Boolean

See Also:

• isStd()

equals

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public boolean equals(Object object)

Overrides:

equals in class BaseParam

hashCode

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public int hashCode()

Overrides:

hashCode in class BaseParam

toString

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public String toString()

Overrides:

toString in class BaseParam

append

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+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 BaseParam

appendFields

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+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 BaseParam

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public void mergeFrom(Object left,
 Object right)

Specified by:

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

Overrides:

mergeFrom in class BaseParam

mergeFrom

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+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 BaseParam

createNewInstance

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public Object createNewInstance()

Specified by:

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

Overrides:

createNewInstance in class BaseParam

clone

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public InputParam clone()

Overrides:

clone in class BaseParam

createCopy

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public InputParam createCopy()

Specified by:

createCopy in interface com.kscs.util.jaxb.Copyable

Overrides:

createCopy in class BaseParam

createCopy

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public InputParam createCopy(com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Specified by:

createCopy in interface com.kscs.util.jaxb.PartialCopyable

Overrides:

createCopy in class BaseParam

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public InputParam copyExcept(com.kscs.util.jaxb.PropertyTree _propertyTree)

Specified by:

copyExcept in interface com.kscs.util.jaxb.PartialCopyable

Overrides:

copyExcept in class BaseParam

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public InputParam copyOnly(com.kscs.util.jaxb.PropertyTree _propertyTree)

Specified by:

copyOnly in interface com.kscs.util.jaxb.PartialCopyable

Overrides:

copyOnly in class BaseParam

modifier

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public InputParam.Modifier modifier()

Overrides:

modifier in class BaseParam

copyTo

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public <_B> void copyTo(InputParam.Builder<_B> _other)

Copies all state of this object to a builder. This method is used by the copyOf method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public <_B> InputParam.Builder<_B> newCopyBuilder(_B _parentBuilder)

Overrides:

newCopyBuilder in class BaseParam

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public InputParam.Builder<Void> newCopyBuilder()

Overrides:

newCopyBuilder in class BaseParam

builder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static InputParam.Builder<Void> builder()

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static <_B> InputParam.Builder<_B> copyOf(BaseParam _other)

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static <_B> InputParam.Builder<_B> copyOf(InputParam _other)

copyTo

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public <_B> void copyTo(InputParam.Builder<_B> _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Copies all state of this object to a builder. This method is used by the copyOf method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public <_B> InputParam.Builder<_B> newCopyBuilder(_B _parentBuilder,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Overrides:

newCopyBuilder in class BaseParam

newCopyBuilder

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public InputParam.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Overrides:

newCopyBuilder in class BaseParam

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static <_B> InputParam.Builder<_B> copyOf(BaseParam _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyOf

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static <_B> InputParam.Builder<_B> copyOf(InputParam _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree,
 com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static InputParam.Builder<Void> copyExcept(BaseParam _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyExcept

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static InputParam.Builder<Void> copyExcept(InputParam _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static InputParam.Builder<Void> copyOnly(BaseParam _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public static InputParam.Builder<Void> copyOnly(InputParam _other,
 com.kscs.util.jaxb.PropertyTree _propertyTree)

visit

@Generated(value="com.sun.tools.xjc.Driver",
           comments="JAXB RI v4.0.4",
           date="2025-09-10T09:00:07+01:00")
public InputParam visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)

Overrides:

visit in class BaseParam