Variant (com4j Parent 2.1 API)

java.lang.Object
- java.lang.Number
- - com4j.Variant

All Implemented Interfaces:

Serializable
```
public final class Variant
extends Number
```
Wraps COM VARIANT data structure.
This class allows you to deal with the raw VARIANT type in case you need it, but in general you should bind VARIANT* to Object or Holder<Object> for more natural Java binding.

Notes
1. Calling methods defined on Number changes the variant type (i.e., similar to a cast in Java) accordingly and returns its value.
Method names that end with '0' are native methods.
Author:

Kohsuke Kawaguchi (kk@kohsuke.org), Michael Schnell (ScM, (C) 2008, 2009, Michael-Schnell@gmx.de)

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Variant.Type
VARIANT type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Variant.Type` VARIANT type.

Field Summary

Fields
Modifier and Type	Field and Description
`static Variant`	`MISSING` Deprecated. This constant instance is mutable (both by Java methods and COM code where this gets passed into as a reference), so it's fundamentally unsafe. use `getMissing()` instead.

Constructor Summary

Constructors
Constructor and Description

Variant()
Creates an empty Variant.

Variant(Variant.Type type)
Creates an empty Variant with the given type.

Constructors
Constructor and Description
`Variant()` Creates an empty `Variant`.
`Variant(Variant.Type type)` Creates an empty `Variant` with the given type.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`booleanValue()` Changes the type of the Variant to `Variant.Type.VT_BOOL` and returns the boolean represented by this Variant
`byte`	`byteValue()` Changes the type of the Variant to `Variant.Type.VT_I1` and returns the byte represented by this Variant
`void`	`clear()` Empties the current contents.
`<T> T`	`convertTo(Class<T> type)` Converts the variant to the given object type.
`double`	`doubleValue()` Changes the type of the Variant to `Variant.Type.VT_R8` and returns the double represented by this Variant
`void`	`finalize()` Makes sure the variant is cleared before GC-ed.
`float`	`floatValue()` Changes the type of the Variant to `Variant.Type.VT_R4` and returns the float represented by this Variant
`Object`	`get()` Retrieves the current contents of the `Variant` and returns an object.
`int`	`getError()` Returns the HRESULT error code of this Variant
`String`	`getJavaCode()` Returns a Java literal as a String of this Variant
`static Variant`	`getMissing()` Generates a new Variant object, representing the VARIANT MISSING
`String`	`getParseableString()` Generates an String representation of this Variant that can be parsed.
`Variant.Type`	`getType()` Gets the type of the variant.
`int`	`intValue()` Changes the type of the Variant to `Variant.Type.VT_I4` and returns the int value represented by this Variant
`boolean`	`isMissing()` Tests if this Variant represents the VARIANT MISSING
`long`	`longValue()` Changes the type of the Variant to `Variant.Type.VT_I8` and returns the long value represented by this Variant
`<T extends Com4jObject> T`	`object(Class<T> type)` Reads this VARIANT as a COM interface pointer.
`void`	`set(boolean b)` Changes the type of the Variant to `Variant.Type.VT_BOOL` and sets its value to the given parameter.
`void`	`set(byte i)` Changes the type of the Variant to `Variant.Type.VT_I1` and sets its value to the given parameter.
`void`	`set(double d)` Changes the type of the Variant to `Variant.Type.VT_R8` and sets its value to the given parameter.
`void`	`set(float f)` Changes the type of the Variant to `Variant.Type.VT_R4` and sets its value to the given parameter.
`void`	`set(int i)` Changes the type of the Variant to `Variant.Type.VT_I4` and sets its value to the given parameter.
`void`	`set(long i)` Changes the type of the Variant to `Variant.Type.VT_I8` and sets its value to the given parameter.
`void`	`set(short i)` Changes the type of the Variant to `Variant.Type.VT_I2` and sets its value to the given parameter.
`void`	`set(String value)` Sets the value of the `Variant` to the given `String`
`void`	`setType(Variant.Type t)` Sets the type of the variant.
`short`	`shortValue()` Changes the type of the Variant to `Variant.Type.VT_I2` and returns the short represented by this Variant
`String`	`stringValue()` Converts this Variant to a String and returns its value
`String`	`toString()` Returns a String representation of this Variant

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

- Field Detail
  - MISSING
```
public static final Variant MISSING
```
    Deprecated. This constant instance is mutable (both by Java methods and COM code where this gets passed into as a reference), so it's fundamentally unsafe. use getMissing() instead.
    
    Represents the special variant instance used for missing parameters.
- Constructor Detail
  - Variant
```
public Variant()
```
    Creates an empty Variant.
  - Variant
```
public Variant(Variant.Type type)
```
    Creates an empty Variant with the given type.
    
    Parameters:
    type - The type of the new Variant.
- Method Detail
  - clear
```
public void clear()
```
    Empties the current contents.
    Sometimes a Variant holds things like interface pointers or arrays, which require some clean up actions. Therefore, when you want to reuse an existing Variant that may hold a value, you should first clear it.
  - finalize
```
public void finalize()
```
    Makes sure the variant is cleared before GC-ed.
    
    Overrides:
    
    finalize in class Object
  - setType
```
public void setType(Variant.Type t)
```
    Sets the type of the variant.
    
    Parameters:
    t - The new type of the Variant
  - getType
```
public Variant.Type getType()
```
    Gets the type of the variant.
    
    Returns:
    The current type of the Variant
  - byteValue
```
public byte byteValue()
```
    Changes the type of the Variant to Variant.Type.VT_I1 and returns the byte represented by this Variant
    
    Overrides:
    
    byteValue in class Number
    
    Returns:
    The byte value of the Variant
  - set
```
public void set(byte i)
```
    Changes the type of the Variant to Variant.Type.VT_I1 and sets its value to the given parameter.
    
    Parameters:
    i - The new value.
  - shortValue
```
public short shortValue()
```
    Changes the type of the Variant to Variant.Type.VT_I2 and returns the short represented by this Variant
    
    Overrides:
    
    shortValue in class Number
    
    Returns:
    the short value of this Variant.
  - set
```
public void set(short i)
```
    Changes the type of the Variant to Variant.Type.VT_I2 and sets its value to the given parameter.
    
    Parameters:
    i - The new value.
  - intValue
```
public int intValue()
```
    Changes the type of the Variant to Variant.Type.VT_I4 and returns the int value represented by this Variant
    
    Specified by:
    
    intValue in class Number
    
    Returns:
    the int value of this Variant.
  - set
```
public void set(int i)
```
    Changes the type of the Variant to Variant.Type.VT_I4 and sets its value to the given parameter.
    
    Parameters:
    i - The new value.
  - longValue
```
public long longValue()
```
    Changes the type of the Variant to Variant.Type.VT_I8 and returns the long value represented by this Variant
    
    Specified by:
    
    longValue in class Number
    
    Returns:
    The long value of this Variant
  - set
```
public void set(long i)
```
    Changes the type of the Variant to Variant.Type.VT_I8 and sets its value to the given parameter.
    
    Parameters:
    i - The new value.
  - getError
```
public int getError()
```
    Returns the HRESULT error code of this Variant
    
    Returns:
    the HRESULT error code.
  - floatValue
```
public float floatValue()
```
    Changes the type of the Variant to Variant.Type.VT_R4 and returns the float represented by this Variant
    
    Specified by:
    
    floatValue in class Number
    
    Returns:
    the float value of this Variant.
  - set
```
public void set(float f)
```
    Changes the type of the Variant to Variant.Type.VT_R4 and sets its value to the given parameter.
    
    Parameters:
    f - The new value.
  - doubleValue
```
public double doubleValue()
```
    Changes the type of the Variant to Variant.Type.VT_R8 and returns the double represented by this Variant
    
    Specified by:
    
    doubleValue in class Number
    
    Returns:
    the double value of this Variant.
  - set
```
public void set(double d)
```
    Changes the type of the Variant to Variant.Type.VT_R8 and sets its value to the given parameter.
    
    Parameters:
    d - The new value.
  - set
```
public void set(boolean b)
```
    Changes the type of the Variant to Variant.Type.VT_BOOL and sets its value to the given parameter.
    
    Parameters:
    b - The new value.
  - booleanValue
```
public boolean booleanValue()
```
    Changes the type of the Variant to Variant.Type.VT_BOOL and returns the boolean represented by this Variant
    
    Returns:
    the boolean value of this Variant.
  - stringValue
```
public String stringValue()
```
    Converts this Variant to a String and returns its value
    
    Returns:
    the String representation of this Variant.
  - set
```
public void set(String value)
```
    Sets the value of the Variant to the given String
    
    Parameters:
    value - The new String value.
  - get
```
public Object get()
```
    Retrieves the current contents of the Variant and returns an object. The type of the object depends on the type of the Variant.
    
    Returns:
    The current value.
    See Also:
    set0(Object, ByteBuffer)
  - getParseableString
```
public String getParseableString()
```
    Generates an String representation of this Variant that can be parsed.
    
    Returns:
    A parsable String representation of this Variant
  - getJavaCode
```
public String getJavaCode()
```
    Returns a Java literal as a String of this Variant
    For example, if the Variant is of the type VT_R4 and its value is 4.6, then the Java literal is "4.6f".
    
    Returns:
    The Java literal.
  - object
```
public <T extends Com4jObject> T object(Class<T> type)
```
    Reads this VARIANT as a COM interface pointer.
    
    Type Parameters:
    T - The type of the return value
    Parameters:
    type - The class object of the type
    
    Returns:
    The Com4jObject of the IUnknown interface pointer that this Variant represents.
  - convertTo
```
public <T> T convertTo(Class<T> type)
```
    Converts the variant to the given object type.
    
    Type Parameters:
    T - The type of the return value.
    Parameters:
    type - The class object of the destination type
    
    Returns:
    An object of type <T>
  - getMissing
```
public static Variant getMissing()
```
    Generates a new Variant object, representing the VARIANT MISSING
    
    Returns:
    A new instance of the MISSING variant.
  - isMissing
```
public boolean isMissing()
```
    Tests if this Variant represents the VARIANT MISSING
    
    Returns:
    true if this Variant represents MISSING, false otherwise.
  - toString
```
public String toString()
```
    Returns a String representation of this Variant
    A Variant consists of 16 bytes in memory. The String representation of a Variant is a sequence of 16 bytes in hex
    
    Overrides:
    
    toString in class Object
    
    Returns:
    The hexadecimal value of the ByteBuffer of this Variant

Class Variant

Notes

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MISSING

Constructor Detail

Variant

Variant

Method Detail

clear

finalize

setType

getType

byteValue

set

shortValue

set

intValue

set

longValue

set

getError

floatValue

set

doubleValue

set

set

booleanValue

stringValue

set

get

getParseableString

getJavaCode

object

convertTo

getMissing

isMissing

toString