generated.docs.javadoc.org.eclipse.dawnsci.nexus.validation.NexusDataType.html Maven / Gradle / Ivy






NexusDataType (h5jan API)











Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Enum Constants | 
Field | 
Method


Detail: 
Enum Constants | 
Field | 
Method








org.eclipse.dawnsci.nexus.validation
Enum NexusDataType



java.lang.Object


java.lang.Enum<NexusDataType>


org.eclipse.dawnsci.nexus.validation.NexusDataType









All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<NexusDataType>




public enum NexusDataType
extends java.lang.Enum<NexusDataType>
Enumeration of Data types allowed in NXDL specifications.
 
 Source: Data Types allowed in NXDL specifications
 
 TODO: establish the full list of valid classes











Enum Constant Summary

Enum Constants 

Enum Constant and Description


NX_BINARY
Any representation of binary data - if text, line terminator is [CR][LF]



NX_BOOLEAN
true/false value ( true | 1 | false | 0 )



NX_CHAR
any string representation



NX_DATE_TIME
Alias for ISO8601.



NX_FLOAT
any representation of a floating point number



NX_INT
any representation of an integer number



NX_NUMBER
any valid NeXus number representation



NX_POSINT
any representation of a positive integer number (greater than zero)
 TODO: add unsigned flag to IDataset



NX_UINT
any representation of an unsigned integer number (includes zero)
 TODO: add unsigned flag to IDataset










Method Summary

All Methods Static Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


void
validate(java.lang.String fieldName,
        IDataset dataset) 


static NexusDataType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.



static NexusDataType[]
values()
Returns an array containing the constants of this enum type, in
the order they are declared.







Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf





Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait














Enum Constant Detail





NX_BINARY
public static final NexusDataType NX_BINARY
Any representation of binary data - if text, line terminator is [CR][LF]







NX_BOOLEAN
public static final NexusDataType NX_BOOLEAN
true/false value ( true | 1 | false | 0 )







NX_CHAR
public static final NexusDataType NX_CHAR
any string representation







NX_DATE_TIME
public static final NexusDataType NX_DATE_TIME
Alias for ISO8601. ISO 8601 date and time representation (http://www.w3.org/TR/NOTE-datetime)







NX_FLOAT
public static final NexusDataType NX_FLOAT
any representation of a floating point number







NX_INT
public static final NexusDataType NX_INT
any representation of an integer number







NX_NUMBER
public static final NexusDataType NX_NUMBER
any valid NeXus number representation







NX_POSINT
public static final NexusDataType NX_POSINT
any representation of a positive integer number (greater than zero)
 TODO: add unsigned flag to IDataset







NX_UINT
public static final NexusDataType NX_UINT
any representation of an unsigned integer number (includes zero)
 TODO: add unsigned flag to IDataset









Method Detail





values
public static NexusDataType[] values()
Returns an array containing the constants of this enum type, in
the order they are declared.  This method may be used to iterate
over the constants as follows:
for (NexusDataType c : NexusDataType.values())
    System.out.println(c);


Returns:
an array containing the constants of this enum type, in the order they are declared








valueOf
public static NexusDataType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
The string must match exactly an identifier used to declare an
enum constant in this type.  (Extraneous whitespace characters are 
not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null








validate
public void validate(java.lang.String fieldName,
                     IDataset dataset)
              throws NexusValidationException

Throws:
NexusValidationException














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Enum Constants | 
Field | 
Method


Detail: 
Enum Constants | 
Field | 
Method
Modifier and Type	Method and Description
`void`	`validate(java.lang.String fieldName, IDataset dataset)`
`static NexusDataType`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static NexusDataType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.