Variant

Defines a container for variant values.

Description

The Variant class allows you to define a container for variant values.

Constructors

Constructs this class and assignes a variant value.

public Variant(Object value)

  • value: Object - value to be assigned to this variant.

Fields

Empty

public static Empty = new [Variant()]

Properties

length

Gets the length of the array

public Integer getLength()

  • returns: number - length of the array or 0.

Sets a new array length

public Integer setLength(Integer value)

  • value: Integer - new array length

type

Gets a type of the variant value

public VariantType getType()

Instance methods

assign

Assignes a new value to this object.

public void assign(Variant value)

  • value: Variant - new value to be assigned.

clear

Clears this object and assignes a VariantType.Null type.

public void clear()

clone

Clones the variant value

public Variant clone()

  • value: Variant - cloned value of this variant

equals

Compares this object to the specified one.

public boolean equals(Object obj)

  • obj: Object - object to be compared.
  • returns: boolean - true if the objects are equal.

getByIndex

Gets an array element by its index.

public Variant getByIndex(int index) throws Exception

  • index: int - element’s index.
  • returns: Variant - requested array element.

isEmpty

Checks is this variant value is empty.

public boolean isEmpty()

  • returns: boolean - true is this variant value is empty.

isNull

Checks is this variant value is Null.

public boolean isNull()

  • returns: boolean - true if this variant value is Null.

setByIndex

Sets an array element by its index.

public void setByIndex(int index, Variant element) throws Exception

  • index: int - element index.
  • element: Variant - element value.

toString

Returns a string value for this object.

public String toString()

  • returns: String - string value for this object.

Static methods

fromArray

Creates a new variant from Array value.

public static Variant fromArray(List<Variant> value)

  • value: Variant - variant value.
  • returns: Variant - created variant object.

fromBoolean

Creates a new variant from a Boolean value.

public static Variant fromBoolean(boolean value)

  • value: boolean - variant value.
  • returns: Variant - created variant object.

fromDateTime

Creates a new variant from a DateTime value.

public static Variant fromDateTime(ZonedDateTime value)

  • value: ZonedDateTime - variant value.
  • returns: Variant - created variant object.

fromDouble

Creates a new variant from a Double value.

public static Variant fromDouble(Double value)

  • value: Double - variant value.
  • returns: Variant - created variant object.

fromFloat

Creates a new variant from a Float value.

public static Variant fromFloat(Float value)

  • value: Float - variant value.
  • returns: Variant - created variant object.

fromInteger

Creates a new variant from an Integer value.

public static Variant fromInteger(Integer value)

  • value: Integer - variant value.
  • returns: Variant - created variant object.

fromLong

Creates a new variant from a Long value.

public static Variant fromLong(Long value)

  • value: Long - variant value.
  • returns: Variant - created variant object.

fromObject

Creates a new variant from an Object value.

public static Variant fromObject(Object value)

  • value: Object - variant value.
  • returns: Variant - created variant object.

fromString

Creates a new variant from a String value.

public static Variant fromString(String value)

  • value: String - variant value.
  • returns: Variant - created variant object.

fromTimeSpan

Creates a new variant from a TimeSpan value.

public static Variant fromTimeSpan(Long value)

  • value: Long - variant value.
  • returns: Variant - created variant object.

getAsInteger

Gets a variant value as Integer

public Integer getAsInteger()

  • returns: Integer - variant value as Integer

setAsInteger

Sets a variant value as Integer

public void setAsInteger(Integer value)

  • value: Integer - variant value as Integer.

getAsLong

Gets a variant value as Long

public Long getAsLong()

  • returns: Long - variant value as Long.

setAsLong

Sets a variant value as Long

public void setAsLong(Long value)

  • value: Long - variant value as Long.

getAsBoolean

Gets a variant value as Boolean.

public Boolean getAsBoolean()

  • returns: Boolean - variant value as Boolean.

setAsBoolean

Sets a variant value as Boolean.

public void setAsBoolean(Boolean value)

  • value: Boolean - variant value as Boolean.

getAsFloat

Sets a variant value as Float.

public Float getAsFloat()

  • returns: Long - variant value as Float.

setAsFloat

Sets a variant value as Float.

public void setAsFloat(Float value)

  • value: Long - variant value as Float.

getAsDouble

Gets a variant value as Double.

public Double getAsDouble()

  • returns: Double - vvariant value as Double.

setAsDouble

Sets a variant value as Double.

public void setAsDouble(Double value)

  • value: Double - vvariant value as Double.

getAsString

Gets a variant value as String.

public String getAsString()

  • returns: String - variant value as String.

setAsString

Sets a variant value as String.

public void setAsString(String value)

  • value: String - variant value as String.

getAsObject

Gets a variant value as Object

public Object getAsObject()

  • returns: Object - created variant object.

setAsObject

Sets variant value as Object

public void setAsObject(Object value)

  • value: Object - created variant object.