javafish.clients.opc.variant
Class Variant

java.lang.Object
  extended by javafish.clients.opc.variant.VariantTypes
      extended by javafish.clients.opc.variant.Variant
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class Variant
extends VariantTypes
implements java.lang.Cloneable, java.lang.Comparable, java.io.Serializable

The Variant types as defined by Microsoft's COM. I found this information in http://www.marin.clara.net/COM/variant_type_definitions.htm.

In the variant types descriptions the following shortcuts are used: [V] - may appear in a VARIANT, [T] - may appear in a TYPEDESC, [P] - may appear in an OLE property set, [S] - may appear in a Safe Array.

Implementation of Variant types => java data types

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javafish.clients.opc.variant.VariantTypes
EPOCH_DIFF, LENGTH_0, LENGTH_2, LENGTH_4, LENGTH_8, LENGTH_UNKNOWN, LENGTH_VARIABLE, VT_ARRAY, VT_BLOB, VT_BLOB_OBJECT, VT_BOOL, VT_BSTR, VT_BYREF, VT_CARRAY, VT_CF, VT_CLSID, VT_CY, VT_DATE, VT_DECIMAL, VT_DISPATCH, VT_EMPTY, VT_ERROR, VT_FILETIME, VT_HRESULT, VT_I1, VT_I2, VT_I4, VT_I8, VT_ILLEGAL, VT_ILLEGALMASKED, VT_INT, VT_LPSTR, VT_LPWSTR, VT_NULL, VT_PTR, VT_R4, VT_R8, VT_RESERVED, VT_SAFEARRAY, VT_STORAGE, VT_STORED_OBJECT, VT_STREAM, VT_STREAMED_OBJECT, VT_TYPEMASK, VT_UI1, VT_UI2, VT_UI4, VT_UI8, VT_UINT, VT_UNKNOWN, VT_USERDEFINED, VT_VARIANT, VT_VECTOR, VT_VOID
 
Constructor Summary
Variant()
          Create new instance of Variant
Variant(boolean value)
          Create new instance of Variant
Variant(byte value)
          Create new instance of byte
Variant(double value)
          Create new instance of Variant
Variant(float value)
          Create new instance of Variant
Variant(int value)
          Create new instance of Variant
Variant(short value)
          Create new instance of short
Variant(java.lang.String value)
          Create new instance of Variant
Variant(Variant value)
          Create new instance of Variant
Variant(VariantList value)
          Create new instance of Variant
 
Method Summary
 java.lang.Object clone()
          Return clone of Variant
 int compareTo(java.lang.Object o)
           
 boolean equals(java.lang.Object obj)
           
 VariantList getArray()
          Get array (VT_ARRAY)
 boolean getBoolean()
          Get value (boolean)
 byte getByte()
          Get value (byte)
 double getDouble()
          Get value (double)
 float getFloat()
          Get value (float)
 int getInteger()
          Get value (int)
 java.lang.String getString()
          Get value (String)
 int getVariantType()
          Get type of variant
 short getWord()
          Get value (short)
 int hashCode()
           
 boolean isEmpty()
          Check empty of variant instance
 java.lang.String toString()
           
 
Methods inherited from class javafish.clients.opc.variant.VariantTypes
dateToFileTime, filetimeToDate, getVariantLength, getVariantName
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Variant

public Variant()
Create new instance of Variant


Variant

public Variant(java.lang.String value)
Create new instance of Variant

Parameters:
value - String

Variant

public Variant(double value)
Create new instance of Variant

Parameters:
value - Double

Variant

public Variant(float value)
Create new instance of Variant

Parameters:
value - float

Variant

public Variant(int value)
Create new instance of Variant

Parameters:
value - int

Variant

public Variant(boolean value)
Create new instance of Variant

Parameters:
value - boolean

Variant

public Variant(Variant value)
Create new instance of Variant

Parameters:
value - Variant

Variant

public Variant(byte value)
Create new instance of byte

Parameters:
value - byte

Variant

public Variant(short value)
Create new instance of short

Parameters:
value - short

Variant

public Variant(VariantList value)
Create new instance of Variant

Parameters:
value - VariantList
Method Detail

getVariantType

public int getVariantType()
Get type of variant

Returns:
type int

getString

public java.lang.String getString()
Get value (String)

Returns:
value String

getDouble

public double getDouble()
Get value (double)

Returns:
value double

getFloat

public float getFloat()
Get value (float)

Returns:
value float

getInteger

public int getInteger()
Get value (int)

Returns:
value int

getBoolean

public boolean getBoolean()
Get value (boolean)

Returns:
value boolean

getByte

public byte getByte()
Get value (byte)

Returns:
value byte

getWord

public short getWord()
Get value (short)

Returns:
value short

isEmpty

public boolean isEmpty()
Check empty of variant instance

Returns:
is empty, boolean

getArray

public VariantList getArray()
Get array (VT_ARRAY)

Returns:
elements VariantList

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

clone

public java.lang.Object clone()
Return clone of Variant

Overrides:
clone in class java.lang.Object
Returns:
item Object

compareTo

public int compareTo(java.lang.Object o)
Specified by:
compareTo in interface java.lang.Comparable

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object