|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object uk.ac.starlink.plastic.MessageDefinition
Describes PLASTIC messages known to this package. Instances of this class describe messages defined by the PLASTIC message definitions list, currently at , perhaps along with other ones known from elsewhere. The message IDs, argument types and return types are given.
Field Summary | |
static MessageDefinition |
FITS_LOADCUBE
|
static MessageDefinition |
FITS_LOADIMAGE
|
static MessageDefinition |
FITS_LOADLINE
|
static MessageDefinition |
HUB_APPREG
|
static MessageDefinition |
HUB_APPUNREG
|
static MessageDefinition |
HUB_STOPPING
|
static MessageDefinition |
INFO_GETDESCRIPTION
|
static MessageDefinition |
INFO_GETICONURL
|
static MessageDefinition |
INFO_GETIVORN
|
static MessageDefinition |
INFO_GETNAME
|
static MessageDefinition |
INFO_GETVERSION
|
static MessageDefinition |
SKY_POINT
|
static MessageDefinition |
SPECTRUM_LOADURL
|
static MessageDefinition |
TEST_ECHO
|
static MessageDefinition |
VOT_HIGHLIGHTOBJECT
|
static MessageDefinition |
VOT_LOAD
|
static MessageDefinition |
VOT_LOADURL
|
static MessageDefinition |
VOT_SHOWOBJECTS
|
Constructor Summary | |
MessageDefinition(String id,
ValueType[] argTypes,
ValueType returnType)
Constructs a message definition whose arguments are all required. |
|
MessageDefinition(String id,
ValueType[] argTypes,
ValueType returnType,
int requiredArgs)
Constructs a message definition which may have some optional arguments. |
Method Summary | |
ValueType[] |
getArgTypes()
Returns an array of the types of the first N arguments which must be sent with this message. |
URI |
getId()
Returns the URI which forms the message ID of this message. |
static MessageDefinition[] |
getKnownMessages()
Returns an array of known standard message definitions. |
static MessageDefinition |
getMessage(URI id)
Returns the message definition corresponding to a given message ID. |
int |
getRequiredArgs()
Returns the number of arguments which are required by this message. |
ValueType |
getReturnType()
Returns the type of the value which must be returned by this message. |
String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final MessageDefinition TEST_ECHO
public static final MessageDefinition INFO_GETIVORN
public static final MessageDefinition INFO_GETNAME
public static final MessageDefinition INFO_GETDESCRIPTION
public static final MessageDefinition INFO_GETVERSION
public static final MessageDefinition INFO_GETICONURL
public static final MessageDefinition HUB_APPREG
public static final MessageDefinition HUB_APPUNREG
public static final MessageDefinition HUB_STOPPING
public static final MessageDefinition VOT_LOAD
public static final MessageDefinition VOT_LOADURL
public static final MessageDefinition VOT_SHOWOBJECTS
public static final MessageDefinition VOT_HIGHLIGHTOBJECT
public static final MessageDefinition FITS_LOADLINE
public static final MessageDefinition FITS_LOADIMAGE
public static final MessageDefinition FITS_LOADCUBE
public static final MessageDefinition SKY_POINT
public static final MessageDefinition SPECTRUM_LOADURL
Constructor Detail |
public MessageDefinition(String id, ValueType[] argTypes, ValueType returnType, int requiredArgs)
id
- message identifier; this must have the form of a URIargTypes
- types of each argumentreturnType
- type of return valuerequiredArgs
- minimum number of arguments for a legal
call of this messagepublic MessageDefinition(String id, ValueType[] argTypes, ValueType returnType)
id
- message identifier; this must have the form of a URIargTypes
- types of each argumentreturnType
- type of return valueMethod Detail |
public URI getId()
ivo://...
".
public ValueType[] getArgTypes()
public ValueType getReturnType()
public int getRequiredArgs()
getArgTypes()
. A message may legally carry a number
of arguments which is larger than either of these values.
public String toString()
public static MessageDefinition[] getKnownMessages()
public static MessageDefinition getMessage(URI id)
id
- message ID
id
, or null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |