java.lang.Object
- org.pipservices3.expressions.variants.Variant

```
public class Variant
extends Object
```
Defines container for variant values.

Field Summary

Fields
Modifier and Type Field Description

static Variant Empty

Constructor Summary

Constructors
Constructor Description

Variant()

Variant(Object value)
Constructs this class and assignes another variant value.

Method Summary

Modifier and Type	Method	Description
`void`	`assign(Variant value)`	Assignes a new value to this object.
`void`	`clear()`	Clears this object and assignes a VariantType.Null type.
`Variant`	`clone()`	Cloning the variant value
`boolean`	`equals(Object obj)`	Compares this object to the specified one.
`static Variant`	`fromArray(List<Variant> value)`	Creates a new variant from Array value.
`static Variant`	`fromBoolean(boolean value)`	Creates a new variant from Boolean value.
`static Variant`	`fromDateTime(ZonedDateTime value)`	Creates a new variant from DateTime value.
`static Variant`	`fromDouble(Double value)`	Creates a new variant from Double value.
`static Variant`	`fromFloat(Float value)`	Creates a new variant from Float value.
`static Variant`	`fromInteger(Integer value)`	Creates a new variant from Integer value.
`static Variant`	`fromLong(Long value)`	Creates a new variant from Long value.
`static Variant`	`fromObject(Object value)`	Creates a new variant from Object value.
`static Variant`	`fromString(String value)`	Creates a new variant from String value.
`static Variant`	`fromTimeSpan(Long value)`	Creates a new variant from TimeSpan value.
`List<Variant>`	`getAsArray()`	Gets variant value as variant array
`Boolean`	`getAsBoolean()`	Gets variant value as boolean
`ZonedDateTime`	`getAsDateTime()`	Gets variant value as DateTime
`Double`	`getAsDouble()`	Gets variant value as double
`Float`	`getAsFloat()`	Gets variant value as float
`Integer`	`getAsInteger()`	Gets variant value as integer
`Long`	`getAsLong()`	Gets variant value as long
`Object`	`getAsObject()`	Gets variant value as Object
`String`	`getAsString()`	Gets variant value as string
`Long`	`getAsTimeSpan()`	Gets variant value as TimeSpan
`Variant`	`getByIndex(int index)`	Gets an array element by its index.
`Integer`	`getLength()`	Gets length of the array
`VariantType`	`getType()`	Gets a type of the variant value
`boolean`	`isEmpty()`	Checks is this variant value empty.
`boolean`	`isNull()`	Checks is this variant value Null.
`void`	`setAsArray(List<Variant> value)`	Sets variant value as variant array
`void`	`setAsBoolean(Boolean value)`	Sets variant value as boolean
`void`	`setAsDateTime(ZonedDateTime value)`	Sets variant value as DateTime
`void`	`setAsDouble(Double value)`	Sets variant value as double
`void`	`setAsFloat(Float value)`	Sets variant value as float
`void`	`setAsInteger(Integer value)`	Sets variant value as integer
`void`	`setAsLong(Long value)`	Sets variant value as long
`void`	`setAsObject(Object value)`	Sets variant value as Object
`void`	`setAsString(String value)`	Sets variant value as string
`void`	`setAsTimeSpan(Long value)`	Sets variant value as TimeSpan
`void`	`setByIndex(int index, Variant element)`	Sets an array element by its index.
`void`	`setLength(int value)`	Sets a new array length
`String`	`toString()`	Returns a string value for this object.

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

- Field Detail
  - Empty
```
public static final Variant Empty
```
- Constructor Detail
  - Variant
```
public Variant(Object value)
```
    Constructs this class and assignes another variant value.
    
    Parameters:
    
    value - a value to be assigned to this variant.
  - Variant
```
public Variant()
```
- Method Detail
  - getType
```
public VariantType getType()
```
    Gets a type of the variant value
    
    Returns:
    
    the variant value type
  - getAsInteger
```
public Integer getAsInteger()
```
    Gets variant value as integer
    
    Returns:
    
    the variant value type
  - setAsInteger
```
public void setAsInteger(Integer value)
```
    Sets variant value as integer
    
    Parameters:
    
    value - a value to be set
  - getAsLong
```
public Long getAsLong()
```
    Gets variant value as long
    
    Returns:
    
    the variant value type
  - setAsLong
```
public void setAsLong(Long value)
```
    Sets variant value as long
    
    Parameters:
    
    value - the variant value type
  - getAsBoolean
```
public Boolean getAsBoolean()
```
    Gets variant value as boolean
    
    Returns:
    
    the variant value type
  - setAsBoolean
```
public void setAsBoolean(Boolean value)
```
    Sets variant value as boolean
    
    Parameters:
    
    value - the variant value type
  - getAsFloat
```
public Float getAsFloat()
```
    Gets variant value as float
    
    Returns:
    
    the variant value type
  - setAsFloat
```
public void setAsFloat(Float value)
```
    Sets variant value as float
    
    Parameters:
    
    value - the variant value type
  - getAsDouble
```
public Double getAsDouble()
```
    Gets variant value as double
  - setAsDouble
```
public void setAsDouble(Double value)
```
    Sets variant value as double
    
    Parameters:
    
    value - a value to be set
  - getAsString
```
public String getAsString()
```
    Gets variant value as string
  - setAsString
```
public void setAsString(String value)
```
    Sets variant value as string
    
    Parameters:
    
    value - a value to be set
  - getAsDateTime
```
public ZonedDateTime getAsDateTime()
```
    Gets variant value as DateTime
  - setAsDateTime
```
public void setAsDateTime(ZonedDateTime value)
```
    Sets variant value as DateTime
    
    Parameters:
    
    value - a value to be set
  - getAsTimeSpan
```
public Long getAsTimeSpan()
```
    Gets variant value as TimeSpan
  - setAsTimeSpan
```
public void setAsTimeSpan(Long value)
```
    Sets variant value as TimeSpan
    
    Parameters:
    
    value - a value to be set
  - getAsObject
```
public Object getAsObject()
```
    Gets variant value as Object
  - setAsObject
```
public void setAsObject(Object value)
```
    Sets variant value as Object
    
    Parameters:
    
    value - a value to be set
  - getAsArray
```
public List<Variant> getAsArray()
```
    Gets variant value as variant array
  - setAsArray
```
public void setAsArray(List<Variant> value)
```
    Sets variant value as variant array
    
    Parameters:
    
    value - a value to be set
  - getLength
```
public Integer getLength()
```
    Gets length of the array
    
    Returns:
    
    The length of the array or 0
  - setLength
```
public void setLength(int value)
               throws Exception
```
    Sets a new array length
    
    Parameters:
    
    value - a new array length
    
    Throws:
    
    Exception
  - getByIndex
```
public Variant getByIndex(int index)
                   throws Exception
```
    Gets an array element by its index.
    
    Parameters:
    
    index - an element index
    
    Returns:
    
    a requested array element
    
    Throws:
    
    Exception
  - setByIndex
```
public void setByIndex(int index,
                       Variant element)
                throws Exception
```
    Sets an array element by its index.
    
    Parameters:
    
    index - an element index
    
    element - an element value
    
    Throws:
    
    Exception
  - isNull
```
public boolean isNull()
```
    Checks is this variant value Null.
    
    Returns:
    
    true if this variant value is Null.
  - isEmpty
```
public boolean isEmpty()
```
    Checks is this variant value empty.
    
    Returns:
    
    true
  assign public void assign(Variant value) Assignes a new value to this object. Parameters: value - A new value to be assigned. clear public void clear() Clears this object and assignes a VariantType.Null type. toString public String toString() Returns a string value for this object. Overrides: toString in class Object Returns: a string value for this object. equals public boolean equals(Object obj) Compares this object to the specified one. Overrides: equals in class Object Parameters: obj - An object to be compared. Returns: true if objects are equal. clone public Variant clone() Cloning the variant value Overrides: clone in class Object Returns: The cloned value of this variant fromInteger public static Variant fromInteger(Integer value) Creates a new variant from Integer value. Parameters: value - a variant value. Returns: a created variant object. fromLong public static Variant fromLong(Long value) Creates a new variant from Long value. Parameters: value - a variant value. Returns: a created variant object. fromBoolean public static Variant fromBoolean(boolean value) Creates a new variant from Boolean value. Parameters: value - a variant value. Returns: a created variant object. fromFloat public static Variant fromFloat(Float value) Creates a new variant from Float value. Parameters: value - a variant value. Returns: a created variant object. fromDouble public static Variant fromDouble(Double value) Creates a new variant from Double value. Parameters: value - a variant value. Returns: a created variant object. fromString public static Variant fromString(String value) Creates a new variant from String value. Parameters: value - a variant value. Returns: a created variant object. fromDateTime public static Variant fromDateTime(ZonedDateTime value) Creates a new variant from DateTime value. Parameters: value - a variant value. Returns: a created variant object. fromTimeSpan public static Variant fromTimeSpan(Long value) Creates a new variant from TimeSpan value. Parameters: value - a variant value. Returns: a created variant object. fromObject public static Variant fromObject(Object value) Creates a new variant from Object value. Parameters: value - a variant value. Returns: a created variant object. fromArray public static Variant fromArray(List<Variant> value) Creates a new variant from Array value. Parameters: value - a variant value. Returns: a created variant object.

Constructor	Description
`Variant()`
`Variant(Object value)`	Constructs this class and assignes another variant value.

Class Variant

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Empty

Constructor Detail

Variant

Variant

Method Detail

getType

getAsInteger

setAsInteger

getAsLong

setAsLong

getAsBoolean

setAsBoolean

getAsFloat

setAsFloat

getAsDouble

setAsDouble

getAsString

setAsString

getAsDateTime

setAsDateTime

getAsTimeSpan

setAsTimeSpan

getAsObject

setAsObject

getAsArray

setAsArray

getLength

setLength

getByIndex

setByIndex

isNull

isEmpty

assign

clear

toString

equals

clone

fromInteger

fromLong

fromBoolean

fromFloat

fromDouble

fromString

fromDateTime

fromTimeSpan

fromObject

fromArray