Java Doc for Variant.java in  » Collaboration » poi-3.0.2-beta2 » org » apache » poi » hpsf » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Collaboration » poi 3.0.2 beta2 » org.apache.poi.hpsf 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.poi.hpsf.Variant

All known Subclasses:   org.apache.poi.hpsf.VariantSupport,
Variant
public class Variant (Code)

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.


author:
   Rainer Klute (klute@rainer-klute.de)
version:
   $Id: Variant.java 489730 2006-12-22 19:18:16Z bayard $
since:
   2002-02-09


Field Summary
final public static  IntegerLENGTH_0
    
final public static  IntegerLENGTH_2
    
final public static  IntegerLENGTH_4
    
final public static  IntegerLENGTH_8
    
final public static  IntegerLENGTH_UNKNOWN
    
final public static  IntegerLENGTH_VARIABLE
    
final public static  intVT_ARRAY
    

[V] SAFEARRAY*.

final public static  intVT_BLOB
    
final public static  intVT_BLOB_OBJECT
    

[P] Blob contains an object.

final public static  intVT_BOOL
    
final public static  intVT_BSTR
    

[V][T][P][S] OLE Automation string.

final public static  intVT_BYREF
    

[V] void* for local use.

final public static  intVT_CARRAY
    

[T] C style array.

final public static  intVT_CF
    

[P] Clipboard format.

final public static  intVT_CLSID
    
final public static  intVT_CY
    

[V][T][P][S] currency.

final public static  intVT_DATE
    

[V][T][P][S] date.

final public static  intVT_DECIMAL
    
final public static  intVT_DISPATCH
    

[V][T][P][S] IDispatch *.

final public static  intVT_EMPTY
    

[V][P] Nothing, i.e.

final public static  intVT_ERROR
    

[V][T][S] SCODE.

final public static  intVT_FILETIME
    

[P] FILETIME.

final public static  intVT_HRESULT
    

[T] Standard return type.

final public static  intVT_I1
    
final public static  intVT_I2
    
final public static  intVT_I4
    
final public static  intVT_I8
    
final public static  intVT_ILLEGAL
    
final public static  intVT_ILLEGALMASKED
    
final public static  intVT_INT
    
final public static  intVT_LPSTR
    
final public static  intVT_LPWSTR
    
final public static  intVT_NULL
    
final public static  intVT_PTR
    

[T] pointer type.

final public static  intVT_R4
    
final public static  intVT_R8
    
final public static  intVT_RESERVED
    
final public static  intVT_SAFEARRAY
    
final public static  intVT_STORAGE
    
final public static  intVT_STORED_OBJECT
    

[P] Storage contains an object.

final public static  intVT_STREAM
    
final public static  intVT_STREAMED_OBJECT
    

[P] Stream contains an object.

final public static  intVT_TYPEMASK
    
final public static  intVT_UI1
    
final public static  intVT_UI2
    
final public static  intVT_UI4
    
final public static  intVT_UI8
    
final public static  intVT_UINT
    
final public static  intVT_UNKNOWN
    

[V][T][S] IUnknown *.

final public static  intVT_USERDEFINED
    

[T] user defined type.

final public static  intVT_VARIANT
    

[V][T][P][S] VARIANT *.

final public static  intVT_VECTOR
    

[P] simple counted array.

final public static  intVT_VOID
    


Method Summary
public static  intgetVariantLength(long variantType)
    

Returns a variant type's length.


Parameters:
  variantType - The variant type number The length of the variant type's data in bytes.
public static  StringgetVariantName(long variantType)
    

Field Detail
LENGTH_0
final public static Integer LENGTH_0(Code)

Denotes a variant type with a length of 0 bytes.




LENGTH_2
final public static Integer LENGTH_2(Code)

Denotes a variant type with a length of 2 bytes.




LENGTH_4
final public static Integer LENGTH_4(Code)

Denotes a variant type with a length of 4 bytes.




LENGTH_8
final public static Integer LENGTH_8(Code)

Denotes a variant type with a length of 8 bytes.




LENGTH_UNKNOWN
final public static Integer LENGTH_UNKNOWN(Code)

Denotes a variant type with a length that is unknown to HPSF yet.




LENGTH_VARIABLE
final public static Integer LENGTH_VARIABLE(Code)

Denotes a variant type with a variable length.




VT_ARRAY
final public static int VT_ARRAY(Code)

[V] SAFEARRAY*. How long is this? How is it to be interpreted?




VT_BLOB
final public static int VT_BLOB(Code)

[P] Length prefixed bytes.




VT_BLOB_OBJECT
final public static int VT_BLOB_OBJECT(Code)

[P] Blob contains an object. How long is this? How is it to be interpreted?




VT_BOOL
final public static int VT_BOOL(Code)

[V][T][P][S] True=-1, False=0.




VT_BSTR
final public static int VT_BSTR(Code)

[V][T][P][S] OLE Automation string. How long is this? How is it to be interpreted?




VT_BYREF
final public static int VT_BYREF(Code)

[V] void* for local use. How long is this? How is it to be interpreted?




VT_CARRAY
final public static int VT_CARRAY(Code)

[T] C style array. How long is this? How is it to be interpreted?




VT_CF
final public static int VT_CF(Code)

[P] Clipboard format. How long is this? How is it to be interpreted?




VT_CLSID
final public static int VT_CLSID(Code)

[P] A Class ID.

It consists of a 32 bit unsigned integer indicating the size of the structure, a 32 bit signed integer indicating (Clipboard Format Tag) indicating the type of data that it contains, and then a byte array containing the data.

The valid Clipboard Format Tags are:

typedef struct tagCLIPDATA {
 // cbSize is the size of the buffer pointed to
 // by pClipData, plus sizeof(ulClipFmt)
 ULONG              cbSize;
 long               ulClipFmt;
 BYTE*              pClipData;
 } CLIPDATA;

See msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp.




VT_CY
final public static int VT_CY(Code)

[V][T][P][S] currency. How long is this? How is it to be interpreted?




VT_DATE
final public static int VT_DATE(Code)

[V][T][P][S] date. How long is this? How is it to be interpreted?




VT_DECIMAL
final public static int VT_DECIMAL(Code)

[V][T][S] 16 byte fixed point.




VT_DISPATCH
final public static int VT_DISPATCH(Code)

[V][T][P][S] IDispatch *. How long is this? How is it to be interpreted?




VT_EMPTY
final public static int VT_EMPTY(Code)

[V][P] Nothing, i.e. not a single byte of data.




VT_ERROR
final public static int VT_ERROR(Code)

[V][T][S] SCODE. How long is this? How is it to be interpreted?




VT_FILETIME
final public static int VT_FILETIME(Code)

[P] FILETIME. The FILETIME structure holds a date and time associated with a file. The structure identifies a 64-bit integer specifying the number of 100-nanosecond intervals which have passed since January 1, 1601. This 64-bit value is split into the two dwords stored in the structure.




VT_HRESULT
final public static int VT_HRESULT(Code)

[T] Standard return type. How long is this? How is it to be interpreted?




VT_I1
final public static int VT_I1(Code)

[T] signed char.




VT_I2
final public static int VT_I2(Code)

[V][T][P][S] 2 byte signed int.




VT_I4
final public static int VT_I4(Code)

[V][T][P][S] 4 byte signed int.




VT_I8
final public static int VT_I8(Code)

[T][P] signed 64-bit int.




VT_ILLEGAL
final public static int VT_ILLEGAL(Code)

FIXME (3): Document this!




VT_ILLEGALMASKED
final public static int VT_ILLEGALMASKED(Code)

FIXME (3): Document this!




VT_INT
final public static int VT_INT(Code)

[T] signed machine int.




VT_LPSTR
final public static int VT_LPSTR(Code)

[T][P] null terminated string.




VT_LPWSTR
final public static int VT_LPWSTR(Code)

[T][P] wide (Unicode) null terminated string.




VT_NULL
final public static int VT_NULL(Code)

[V][P] SQL style Null.




VT_PTR
final public static int VT_PTR(Code)

[T] pointer type. How long is this? How is it to be interpreted?




VT_R4
final public static int VT_R4(Code)

[V][T][P][S] 4 byte real.




VT_R8
final public static int VT_R8(Code)

[V][T][P][S] 8 byte real.




VT_RESERVED
final public static int VT_RESERVED(Code)

FIXME (3): Document this!




VT_SAFEARRAY
final public static int VT_SAFEARRAY(Code)

[T] (use VT_ARRAY in VARIANT).




VT_STORAGE
final public static int VT_STORAGE(Code)

[P] Name of the storage follows.




VT_STORED_OBJECT
final public static int VT_STORED_OBJECT(Code)

[P] Storage contains an object. How long is this? How is it to be interpreted?




VT_STREAM
final public static int VT_STREAM(Code)

[P] Name of the stream follows.




VT_STREAMED_OBJECT
final public static int VT_STREAMED_OBJECT(Code)

[P] Stream contains an object. How long is this? How is it to be interpreted?




VT_TYPEMASK
final public static int VT_TYPEMASK(Code)

FIXME (3): Document this!




VT_UI1
final public static int VT_UI1(Code)

[V][T][P][S] unsigned char.




VT_UI2
final public static int VT_UI2(Code)

[T][P] unsigned short.




VT_UI4
final public static int VT_UI4(Code)

[T][P] unsigned int.




VT_UI8
final public static int VT_UI8(Code)

[T][P] unsigned 64-bit int.




VT_UINT
final public static int VT_UINT(Code)

[T] unsigned machine int.




VT_UNKNOWN
final public static int VT_UNKNOWN(Code)

[V][T][S] IUnknown *. How long is this? How is it to be interpreted?




VT_USERDEFINED
final public static int VT_USERDEFINED(Code)

[T] user defined type. How long is this? How is it to be interpreted?




VT_VARIANT
final public static int VT_VARIANT(Code)

[V][T][P][S] VARIANT *. How long is this? How is it to be interpreted?




VT_VECTOR
final public static int VT_VECTOR(Code)

[P] simple counted array. How long is this? How is it to be interpreted?




VT_VOID
final public static int VT_VOID(Code)

[T] C style void.






Method Detail
getVariantLength
public static int getVariantLength(long variantType)(Code)

Returns a variant type's length.


Parameters:
  variantType - The variant type number The length of the variant type's data in bytes. If the length isvariable, i.e. the length of a string, -1 is returned. If HPSF does notknow the length, -2 is returned. The latter usually indicates anunsupported variant type.



getVariantName
public static String getVariantName(long variantType)(Code)

Returns the variant type name associated with a variant type number.


Parameters:
  variantType - The variant type number The variant type name or the string "unknown variant type"



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.