Variant (docx4j-openxml-objects 8.3.4 API)

java.lang.Object
- org.docx4j.docProps.variantTypes.Variant

public class Variant
extends Object

Java class for CT_Variant complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="CT_Variant">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}variant"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}vector"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}array"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}blob"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}oblob"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}empty"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}null"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}i1"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}i2"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}i4"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}i8"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}int"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}ui1"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}ui2"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}ui4"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}ui8"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}uint"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}r4"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}r8"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}decimal"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}lpstr"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}lpwstr"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}bstr"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}date"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}filetime"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}bool"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}cy"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}error"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}stream"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}ostream"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}storage"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}ostorage"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}vstream"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}clsid"/>
         <element ref="{http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes}cf"/>
       </choice>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`_int`
`protected Null`	`_null`
`protected Array`	`array`
`protected byte[]`	`blob`
`protected Boolean`	`bool`
`protected String`	`bstr`
`protected Cf`	`cf`
`protected String`	`clsid`
`protected String`	`cy`
`protected XMLGregorianCalendar`	`date`
`protected BigDecimal`	`decimal`
`protected Empty`	`empty`
`protected String`	`error`
`protected XMLGregorianCalendar`	`filetime`
`protected Byte`	`i1`
`protected Short`	`i2`
`protected Integer`	`i4`
`protected Long`	`i8`
`protected String`	`lpstr`
`protected String`	`lpwstr`
`protected byte[]`	`oblob`
`protected byte[]`	`ostorage`
`protected byte[]`	`ostream`
`protected Float`	`r4`
`protected Double`	`r8`
`protected byte[]`	`storage`
`protected byte[]`	`stream`
`protected Short`	`ui1`
`protected Integer`	`ui2`
`protected Long`	`ui4`
`protected BigInteger`	`ui8`
`protected Long`	`uint`
`protected Variant`	`variant`
`protected Vector`	`vector`
`protected Vstream`	`vstream`

Constructor Summary

Constructors
Constructor and Description

Variant()

Constructors
Constructor and Description
`Variant()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Array`	`getArray()` Array
`byte[]`	`getBlob()` Binary Blob
`String`	`getBstr()` Basic String
`Cf`	`getCf()` Clipboard Data
`String`	`getClsid()` Class ID
`String`	`getCy()` Currency
`XMLGregorianCalendar`	`getDate()` Date and Time
`BigDecimal`	`getDecimal()` Decimal
`Empty`	`getEmpty()` Empty
`String`	`getError()` Error Status Code
`XMLGregorianCalendar`	`getFiletime()` File Time
`Byte`	`getI1()` 1-Byte Signed Integer
`Short`	`getI2()` 2-Byte Signed Integer
`Integer`	`getI4()` 4-Byte Signed Integer
`Long`	`getI8()` 8-Byte Signed Integer
`Integer`	`getInt()` Integer
`String`	`getLpstr()` LPSTR
`String`	`getLpwstr()` LPWSTR
`Null`	`getNull()` Null
`byte[]`	`getOblob()` Binary Blob Object
`byte[]`	`getOstorage()` Binary Storage Object
`byte[]`	`getOstream()` Binary Stream Object
`Float`	`getR4()` 4-Byte Real Number
`Double`	`getR8()` 8-Byte Real Number
`byte[]`	`getStorage()` Binary Storage
`byte[]`	`getStream()` Binary Stream
`Short`	`getUi1()` 1-Byte Unsigned Integer
`Integer`	`getUi2()` 2-Byte Unsigned Integer
`Long`	`getUi4()` 4-Byte Unsigned Integer
`BigInteger`	`getUi8()` 8-Byte Unsigned Integer
`Long`	`getUint()` Unsigned Integer
`Variant`	`getVariant()` Variant
`Vector`	`getVector()` Vector
`Vstream`	`getVstream()` Binary Versioned Stream
`Boolean`	`isBool()` Boolean
`void`	`setArray(Array value)` Sets the value of the array property.
`void`	`setBlob(byte[] value)` Sets the value of the blob property.
`void`	`setBool(Boolean value)` Sets the value of the bool property.
`void`	`setBstr(String value)` Sets the value of the bstr property.
`void`	`setCf(Cf value)` Sets the value of the cf property.
`void`	`setClsid(String value)` Sets the value of the clsid property.
`void`	`setCy(String value)` Sets the value of the cy property.
`void`	`setDate(XMLGregorianCalendar value)` Sets the value of the date property.
`void`	`setDecimal(BigDecimal value)` Sets the value of the decimal property.
`void`	`setEmpty(Empty value)` Sets the value of the empty property.
`void`	`setError(String value)` Sets the value of the error property.
`void`	`setFiletime(XMLGregorianCalendar value)` Sets the value of the filetime property.
`void`	`setI1(Byte value)` Sets the value of the i1 property.
`void`	`setI2(Short value)` Sets the value of the i2 property.
`void`	`setI4(Integer value)` Sets the value of the i4 property.
`void`	`setI8(Long value)` Sets the value of the i8 property.
`void`	`setInt(Integer value)` Sets the value of the int property.
`void`	`setLpstr(String value)` Sets the value of the lpstr property.
`void`	`setLpwstr(String value)` Sets the value of the lpwstr property.
`void`	`setNull(Null value)` Sets the value of the null property.
`void`	`setOblob(byte[] value)` Sets the value of the oblob property.
`void`	`setOstorage(byte[] value)` Sets the value of the ostorage property.
`void`	`setOstream(byte[] value)` Sets the value of the ostream property.
`void`	`setR4(Float value)` Sets the value of the r4 property.
`void`	`setR8(Double value)` Sets the value of the r8 property.
`void`	`setStorage(byte[] value)` Sets the value of the storage property.
`void`	`setStream(byte[] value)` Sets the value of the stream property.
`void`	`setUi1(Short value)` Sets the value of the ui1 property.
`void`	`setUi2(Integer value)` Sets the value of the ui2 property.
`void`	`setUi4(Long value)` Sets the value of the ui4 property.
`void`	`setUi8(BigInteger value)` Sets the value of the ui8 property.
`void`	`setUint(Long value)` Sets the value of the uint property.
`void`	`setVariant(Variant value)` Sets the value of the variant property.
`void`	`setVector(Vector value)` Sets the value of the vector property.
`void`	`setVstream(Vstream value)` Sets the value of the vstream property.

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

- Field Detail
  - variant
```
protected Variant variant
```
  - vector
```
protected Vector vector
```
  - array
```
protected Array array
```
  - blob
```
protected byte[] blob
```
  - oblob
```
protected byte[] oblob
```
  - empty
```
protected Empty empty
```
  - _null
```
protected Null _null
```
  - i1
```
protected Byte i1
```
  - i2
```
protected Short i2
```
  - i4
```
protected Integer i4
```
  - i8
```
protected Long i8
```
  - _int
```
protected Integer _int
```
  - ui1
```
protected Short ui1
```
  - ui2
```
protected Integer ui2
```
  - ui4
```
protected Long ui4
```
  - ui8
```
protected BigInteger ui8
```
  - uint
```
protected Long uint
```
  - r4
```
protected Float r4
```
  - r8
```
protected Double r8
```
  - decimal
```
protected BigDecimal decimal
```
  - lpstr
```
protected String lpstr
```
  - lpwstr
```
protected String lpwstr
```
  - bstr
```
protected String bstr
```
  - date
```
protected XMLGregorianCalendar date
```
  - filetime
```
protected XMLGregorianCalendar filetime
```
  - bool
```
protected Boolean bool
```
  - cy
```
protected String cy
```
  - error
```
protected String error
```
  - stream
```
protected byte[] stream
```
  - ostream
```
protected byte[] ostream
```
  - storage
```
protected byte[] storage
```
  - ostorage
```
protected byte[] ostorage
```
  - vstream
```
protected Vstream vstream
```
  - clsid
```
protected String clsid
```
  - cf
```
protected Cf cf
```
- Constructor Detail
  - Variant
```
public Variant()
```
- Method Detail
  - getVariant
```
public Variant getVariant()
```
    Variant
    
    Returns:
    
    possible object is Variant
  - setVariant
```
public void setVariant(Variant value)
```
    Sets the value of the variant property.
    
    Parameters:
    
    value - allowed object is Variant
  - getVector
```
public Vector getVector()
```
    Vector
    
    Returns:
    
    possible object is Vector
  - setVector
```
public void setVector(Vector value)
```
    Sets the value of the vector property.
    
    Parameters:
    
    value - allowed object is Vector
  - getArray
```
public Array getArray()
```
    Array
    
    Returns:
    
    possible object is Array
  - setArray
```
public void setArray(Array value)
```
    Sets the value of the array property.
    
    Parameters:
    
    value - allowed object is Array
  - getBlob
```
public byte[] getBlob()
```
    Binary Blob
    
    Returns:
    
    possible object is byte[]
  - setBlob
```
public void setBlob(byte[] value)
```
    Sets the value of the blob property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getOblob
```
public byte[] getOblob()
```
    Binary Blob Object
    
    Returns:
    
    possible object is byte[]
  - setOblob
```
public void setOblob(byte[] value)
```
    Sets the value of the oblob property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getEmpty
```
public Empty getEmpty()
```
    Empty
    
    Returns:
    
    possible object is Empty
  - setEmpty
```
public void setEmpty(Empty value)
```
    Sets the value of the empty property.
    
    Parameters:
    
    value - allowed object is Empty
  - getNull
```
public Null getNull()
```
    Null
    
    Returns:
    
    possible object is Null
  - setNull
```
public void setNull(Null value)
```
    Sets the value of the null property.
    
    Parameters:
    
    value - allowed object is Null
  - getI1
```
public Byte getI1()
```
    1-Byte Signed Integer
    
    Returns:
    
    possible object is Byte
  - setI1
```
public void setI1(Byte value)
```
    Sets the value of the i1 property.
    
    Parameters:
    
    value - allowed object is Byte
  - getI2
```
public Short getI2()
```
    2-Byte Signed Integer
    
    Returns:
    
    possible object is Short
  - setI2
```
public void setI2(Short value)
```
    Sets the value of the i2 property.
    
    Parameters:
    
    value - allowed object is Short
  - getI4
```
public Integer getI4()
```
    4-Byte Signed Integer
    
    Returns:
    
    possible object is Integer
  - setI4
```
public void setI4(Integer value)
```
    Sets the value of the i4 property.
    
    Parameters:
    
    value - allowed object is Integer
  - getI8
```
public Long getI8()
```
    8-Byte Signed Integer
    
    Returns:
    
    possible object is Long
  - setI8
```
public void setI8(Long value)
```
    Sets the value of the i8 property.
    
    Parameters:
    
    value - allowed object is Long
  - getInt
```
public Integer getInt()
```
    Integer
    
    Returns:
    
    possible object is Integer
  - setInt
```
public void setInt(Integer value)
```
    Sets the value of the int property.
    
    Parameters:
    
    value - allowed object is Integer
  - getUi1
```
public Short getUi1()
```
    1-Byte Unsigned Integer
    
    Returns:
    
    possible object is Short
  - setUi1
```
public void setUi1(Short value)
```
    Sets the value of the ui1 property.
    
    Parameters:
    
    value - allowed object is Short
  - getUi2
```
public Integer getUi2()
```
    2-Byte Unsigned Integer
    
    Returns:
    
    possible object is Integer
  - setUi2
```
public void setUi2(Integer value)
```
    Sets the value of the ui2 property.
    
    Parameters:
    
    value - allowed object is Integer
  - getUi4
```
public Long getUi4()
```
    4-Byte Unsigned Integer
    
    Returns:
    
    possible object is Long
  - setUi4
```
public void setUi4(Long value)
```
    Sets the value of the ui4 property.
    
    Parameters:
    
    value - allowed object is Long
  - getUi8
```
public BigInteger getUi8()
```
    8-Byte Unsigned Integer
    
    Returns:
    
    possible object is BigInteger
  - setUi8
```
public void setUi8(BigInteger value)
```
    Sets the value of the ui8 property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getUint
```
public Long getUint()
```
    Unsigned Integer
    
    Returns:
    
    possible object is Long
  - setUint
```
public void setUint(Long value)
```
    Sets the value of the uint property.
    
    Parameters:
    
    value - allowed object is Long
  - getR4
```
public Float getR4()
```
    4-Byte Real Number
    
    Returns:
    
    possible object is Float
  - setR4
```
public void setR4(Float value)
```
    Sets the value of the r4 property.
    
    Parameters:
    
    value - allowed object is Float
  - getR8
```
public Double getR8()
```
    8-Byte Real Number
    
    Returns:
    
    possible object is Double
  - setR8
```
public void setR8(Double value)
```
    Sets the value of the r8 property.
    
    Parameters:
    
    value - allowed object is Double
  - getDecimal
```
public BigDecimal getDecimal()
```
    Decimal
    
    Returns:
    
    possible object is BigDecimal
  - setDecimal
```
public void setDecimal(BigDecimal value)
```
    Sets the value of the decimal property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getLpstr
```
public String getLpstr()
```
    LPSTR
    
    Returns:
    
    possible object is String
  - setLpstr
```
public void setLpstr(String value)
```
    Sets the value of the lpstr property.
    
    Parameters:
    
    value - allowed object is String
  - getLpwstr
```
public String getLpwstr()
```
    LPWSTR
    
    Returns:
    
    possible object is String
  - setLpwstr
```
public void setLpwstr(String value)
```
    Sets the value of the lpwstr property.
    
    Parameters:
    
    value - allowed object is String
  - getBstr
```
public String getBstr()
```
    Basic String
    
    Returns:
    
    possible object is String
  - setBstr
```
public void setBstr(String value)
```
    Sets the value of the bstr property.
    
    Parameters:
    
    value - allowed object is String
  - getDate
```
public XMLGregorianCalendar getDate()
```
    Date and Time
    
    Returns:
    
    possible object is XMLGregorianCalendar
  - setDate
```
public void setDate(XMLGregorianCalendar value)
```
    Sets the value of the date property.
    
    Parameters:
    
    value - allowed object is XMLGregorianCalendar
  - getFiletime
```
public XMLGregorianCalendar getFiletime()
```
    File Time
    
    Returns:
    
    possible object is XMLGregorianCalendar
  - setFiletime
```
public void setFiletime(XMLGregorianCalendar value)
```
    Sets the value of the filetime property.
    
    Parameters:
    
    value - allowed object is XMLGregorianCalendar
  - isBool
```
public Boolean isBool()
```
    Boolean
    
    Returns:
    
    possible object is Boolean
  - setBool
```
public void setBool(Boolean value)
```
    Sets the value of the bool property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getCy
```
public String getCy()
```
    Currency
    
    Returns:
    
    possible object is String
  - setCy
```
public void setCy(String value)
```
    Sets the value of the cy property.
    
    Parameters:
    
    value - allowed object is String
  - getError
```
public String getError()
```
    Error Status Code
    
    Returns:
    
    possible object is String
  - setError
```
public void setError(String value)
```
    Sets the value of the error property.
    
    Parameters:
    
    value - allowed object is String
  - getStream
```
public byte[] getStream()
```
    Binary Stream
    
    Returns:
    
    possible object is byte[]
  - setStream
```
public void setStream(byte[] value)
```
    Sets the value of the stream property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getOstream
```
public byte[] getOstream()
```
    Binary Stream Object
    
    Returns:
    
    possible object is byte[]
  - setOstream
```
public void setOstream(byte[] value)
```
    Sets the value of the ostream property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getStorage
```
public byte[] getStorage()
```
    Binary Storage
    
    Returns:
    
    possible object is byte[]
  - setStorage
```
public void setStorage(byte[] value)
```
    Sets the value of the storage property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getOstorage
```
public byte[] getOstorage()
```
    Binary Storage Object
    
    Returns:
    
    possible object is byte[]
  - setOstorage
```
public void setOstorage(byte[] value)
```
    Sets the value of the ostorage property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getVstream
```
public Vstream getVstream()
```
    Binary Versioned Stream
    
    Returns:
    
    possible object is Vstream
  - setVstream
```
public void setVstream(Vstream value)
```
    Sets the value of the vstream property.
    
    Parameters:
    
    value - allowed object is Vstream
  - getClsid
```
public String getClsid()
```
    Class ID
    
    Returns:
    
    possible object is String
  - setClsid
```
public void setClsid(String value)
```
    Sets the value of the clsid property.
    
    Parameters:
    
    value - allowed object is String
  - getCf
```
public Cf getCf()
```
    Clipboard Data
    
    Returns:
    
    possible object is Cf
  - setCf
```
public void setCf(Cf value)
```
    Sets the value of the cf property.
    
    Parameters:
    
    value - allowed object is Cf

Class Variant

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

variant

vector

array

blob

oblob

empty

_null

i1

i2

i4

i8

_int

ui1

ui2

ui4

ui8

uint

r4

r8

decimal

lpstr

lpwstr

bstr

date

filetime

bool

cy

error

stream

ostream

storage

ostorage

vstream

clsid

cf

Constructor Detail

Variant

Method Detail

getVariant

setVariant

getVector

setVector

getArray

setArray

getBlob

setBlob

getOblob

setOblob

getEmpty

setEmpty

getNull

setNull

getI1

setI1

getI2

setI2

getI4

setI4

getI8

setI8

getInt

setInt

getUi1

setUi1

getUi2

setUi2

getUi4

setUi4

getUi8

setUi8

getUint

setUint

getR4

setR4