|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.poifs.property.Property
public abstract class Property
This abstract base class is the ancestor of all classes implementing POIFS Property behavior.
Method Summary | |
---|---|
java.lang.String |
getName()
Get the name of this property |
Child |
getNextChild()
Get the next Child, if any |
Child |
getPreviousChild()
Get the previous Child, if any |
java.lang.String |
getShortDescription()
Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents. |
int |
getSize()
find out the document size |
int |
getStartBlock()
|
ClassID |
getStorageClsid()
Sets the storage clsid, which is the Class ID of a COM object which reads and writes this stream |
java.lang.Object[] |
getViewableArray()
Get an array of objects, some of which may implement POIFSViewable |
java.util.Iterator |
getViewableIterator()
Get an Iterator of objects, some of which may implement POIFSViewable |
abstract boolean |
isDirectory()
|
static boolean |
isSmall(int length)
does the length indicate a small document? |
boolean |
preferArray()
Give viewers a hint as to whether to call getViewableArray or getViewableIterator |
void |
setNextChild(Child child)
Set the next Child |
void |
setPreviousChild(Child child)
Set the previous Child |
void |
setStartBlock(int startBlock)
Set the start block for the document referred to by this Property. |
void |
setStorageClsid(ClassID clsidStorage)
Sets the storage class ID for this property stream. |
boolean |
shouldUseSmallBlocks()
Based on the currently defined size, should this property use small blocks? |
void |
writeData(java.io.OutputStream stream)
Write the raw data to an OutputStream. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void writeData(java.io.OutputStream stream) throws java.io.IOException
stream
- the OutputStream to which the data should be
written.
java.io.IOException
- on problems writing to the specified
stream.public void setStartBlock(int startBlock)
startBlock
- the start block indexpublic int getStartBlock()
public int getSize()
public boolean shouldUseSmallBlocks()
public static boolean isSmall(int length)
length
- length in bytes
public java.lang.String getName()
public abstract boolean isDirectory()
public ClassID getStorageClsid()
public void setStorageClsid(ClassID clsidStorage)
clsidStorage
- Storage Class IDpublic Child getNextChild()
getNextChild
in interface Child
public Child getPreviousChild()
getPreviousChild
in interface Child
public void setNextChild(Child child)
setNextChild
in interface Child
child
- the new 'next' child; may be null, which has the
effect of saying there is no 'next' childpublic void setPreviousChild(Child child)
setPreviousChild
in interface Child
child
- the new 'previous' child; may be null, which has
the effect of saying there is no 'previous' childpublic java.lang.Object[] getViewableArray()
getViewableArray
in interface POIFSViewable
public java.util.Iterator getViewableIterator()
getViewableIterator
in interface POIFSViewable
public boolean preferArray()
preferArray
in interface POIFSViewable
public java.lang.String getShortDescription()
getShortDescription
in interface POIFSViewable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |