Obj (PDFTron PDFNet SDK API Reference)

java.lang.Object
- pdftron.SDF.Obj

```
public class Obj
extends java.lang.Object
```
Obj is a concrete class for all SDF/Cos objects. Obj hierarchy implements the composite design pattern. As a result, you can invoke a member function of any 'derived' object through Obj interface. If the member function is not supported (e.g. if you invoke Obj::GetNumber() on a boolean object) an Exception will be thrown. You can use GetType() or obl.Is???() member functions to find out type-information at run time, however most of the time the type can be inferred from the PDF specification. Therefore when you call Doc::GetTrailer() you can assume that returned object is a dictionary. If there is any ambiguity use Is???() methods. Objects can't be shared across documents, however you can use Doc::ImportObj() to copy objects from one document to another. Objects can be shared within a document provided that they are created as indirect. Indirect objects are the ones that are referenced in cross-reference table. To create an object as indirect use Doc::CreateIndirect???() (where ? is the Object type).

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`e_array` The Constant e_array.
`static int`	`e_bool` The Constant e_bool.
`static int`	`e_dict` The Constant e_dict.
`static int`	`e_name` The Constant e_name.
`static int`	`e_null` The Constant e_null.
`static int`	`e_number` The Constant e_number.
`static int`	`e_stream` The Constant e_stream.
`static int`	`e_string` The Constant e_string.

Method Summary

Methods
Modifier and Type	Method and Description
`static Obj`	`__Create(long impl, java.lang.Object ref)`
`long`	`__GetHandle()`
`java.lang.Object`	`__GetRefHandle()`
`void`	`erase(DictIterator pos)` Removes an element in the dictionary from specified position.
`void`	`erase(java.lang.String key)` Removes an element in the dictionary that matches the given key.
`void`	`eraseAt(int pos)` Checks whether the position is within the array bounds and then removes it from the array and moves each subsequent element to the slot with the next smaller index and decrements the arrays length by 1.
`DictIterator`	`find(java.lang.String key)` Search the dictionary for a given key.
`Obj`	`findObj(java.lang.String key)` Search the dictionary for a given key.
`DictIterator`	`get(java.lang.String key)` Search the dictionary for a given key and throw an exception if the key is not found.
`java.lang.String`	`getAsPDFText()` Convert the SDF/Cos String object to 'PDF Text String' (a Unicode string).
`Obj`	`getAt(int index)` Get the Obj at specified index
`boolean`	`getBool()` Get the boolean value if Obj is bool
`byte[]`	`getBuffer()` Get string buffer
`Filter`	`getDecodedStream()` Get the decoded stream.
`DictIterator`	`getDictIterator()` Get the dictionary iterator.
`SDFDoc`	`getDoc()` Get the Doc object contains this Obj
`short`	`getGenNum()` Get the generation number.
`java.lang.String`	`getName()` Get the string representation of the Name object
`double`	`getNumber()` Get the number value
`long`	`getObjNum()` Get the object number.
`long`	`getOffset()` Get the offset from beginning of the file.
`Filter`	`getRawStream(boolean decrypt)` Get the raw stream.
`long`	`getRawStreamLength()` Get the raw stream length.
`int`	`getType()` Get the Obj type.
`Obj`	`insert(int pos, Obj obj)` Inserts an existing Obj in this array.
`Obj`	`insertArray(int pos)` Inserts an Obj::Type::e_array object in the array.
`Obj`	`insertBool(int pos, boolean value)` Inserts an Obj::Type::e_bool object in the array.
`Obj`	`insertDict(int pos)` Inserts an Obj::Type::e_dict object in the array.
`Obj`	`insertMatrix(int pos, Matrix2D value)` Inserts an array of 6 numbers in this array.
`Obj`	`insertName(int pos, java.lang.String name)` Inserts an Obj::Type::e_name object in the array.
`Obj`	`insertNull(int pos)` Inserts an Obj::Type::e_null object in the array.
`Obj`	`insertNumber(int pos, double value)` Inserts an Obj::Type::e_number object in the array.
`Obj`	`insertRect(int pos, double x1, double y1, double x2, double y2)` Inserts an array of 4 numbers in this array.
`Obj`	`insertString(int pos, byte[] value)` Inserts an Obj::Type::e_string object in the array.
`Obj`	`insertString(int pos, java.lang.String value)` Inserts an Obj::Type::e_string object in the array.
`Obj`	`insertText(int pos, java.lang.String value)` Inserts an Obj::Type::e_string object in the array.
`boolean`	`isArray()` Checks if Obj is an array.
`boolean`	`isBool()` Checks if Obj is Boolean object
`boolean`	`isContainer()` Checks if Obj is a container object.
`boolean`	`isDict()` Checks if Obj is dictionary
`boolean`	`isEqual(Obj to)` Checks if is equal to specified object
`boolean`	`isFree()` Checks if it is marked as free.
`boolean`	`isIndirect()` Checks if Obj is an indirect object
`boolean`	`isLoaded()` Checks if Obj is loaded.
`boolean`	`isMarked()` Checks if Obj is marked.
`boolean`	`isName()` Checks if Obj is a name object.
`boolean`	`isNull()` Checks if is Obj null.
`boolean`	`isNumber()` Checks if Obj is Number object.
`boolean`	`isStream()` Checks if is a stream.
`boolean`	`isString()` Checks if Obj is a string object.
`Obj`	`pushBack(Obj obj)` Appends an existing Obj at the end of the array.
`Obj`	`pushBackArray()` Appends a new Obj::Type::e_array object at the end of the array.
`Obj`	`pushBackBool(boolean value)` Appends a new Obj::Type::e_bool object at the end of the array.
`Obj`	`pushBackDict()` Appends a new Obj::Type::e_dict object at the end of the array.
`Obj`	`pushBackMatrix(Matrix2D value)` Appends an array of 6 numbers at the end of the array.
`Obj`	`pushBackName(java.lang.String name)` Appends a new Obj::Type::e_name object at the end of the array.
`Obj`	`pushBackNull()` Appends a new Obj::Type::e_null object at the end of the array.
`Obj`	`pushBackNumber(double value)` Appends a new Obj::Type::e_number object at the end of the array.
`Obj`	`pushBackRect(double x1, double y1, double x2, double y2)` Appends an array of 4 numbers at the end of the array.
`Obj`	`pushBackString(byte[] value)` Appends a new Obj::Type::e_string object at the end of the array.
`Obj`	`pushBackString(java.lang.String value)` Appends a new Obj::Type::e_string object at the end of the array.
`Obj`	`pushBackText(java.lang.String value)` Appends a new Obj::Type::e_string object at the end of the array.
`Obj`	`put(java.lang.String key, Obj obj)` Inserts a pair in the dictionary.
`Obj`	`putArray(java.lang.String key)` Inserts a pair in the dictionary.
`Obj`	`putBool(java.lang.String key, boolean value)` Inserts a pair in the dictionary.
`Obj`	`putDict(java.lang.String key)` Inserts a pair in the dictionary.
`Obj`	`putMatrix(java.lang.String key, Matrix2D value)` Inserts a pair in the dictionary.
`Obj`	`putName(java.lang.String key, java.lang.String name)` Inserts a pair in the dictionary.
`void`	`putNull(java.lang.String key)` Inserts a pair in the dictionary.
`Obj`	`putNumber(java.lang.String key, double value)` Inserts a pair in the dictionary.
`Obj`	`putRect(java.lang.String key, double x1, double y1, double x2, double y2)` Inserts a pair in the dictionary.
`Obj`	`putString(java.lang.String key, byte[] value)` Inserts a pair in the dictionary.
`Obj`	`putString(java.lang.String key, java.lang.String value)` Inserts a pair in the dictionary.
`Obj`	`putText(java.lang.String key, java.lang.String value)` Inserts a pair in the dictionary.
`boolean`	`rename(java.lang.String old_key, java.lang.String new_key)` Change the key value of a dictionary entry.
`void`	`setBool(boolean b)` Set the boolean value to Obj
`void`	`setMark(boolean mark)` Set the object mark.
`void`	`setName(java.lang.String name)` Set the name string
`void`	`setNumber(double n)` Set the number value
`void`	`setStreamData(byte[] data, Filter filter_chain)` Update a stream object with the new content.
`void`	`setString(byte[] buf)` Set the string object value.
`void`	`setString(java.lang.String value)` Set the string object value.
`long`	`size()` Get size of Obj
`void`	`write(FilterWriter stream)` The function writes the Obj to the output stream.

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

- Field Detail
  - e_null
```
public static final int e_null
```
    The Constant e_null.
    
    See Also:
    Constant Field Values
  - e_bool
```
public static final int e_bool
```
    The Constant e_bool.
    
    See Also:
    Constant Field Values
  - e_number
```
public static final int e_number
```
    The Constant e_number.
    
    See Also:
    Constant Field Values
  - e_name
```
public static final int e_name
```
    The Constant e_name.
    
    See Also:
    Constant Field Values
  - e_string
```
public static final int e_string
```
    The Constant e_string.
    
    See Also:
    Constant Field Values
  - e_dict
```
public static final int e_dict
```
    The Constant e_dict.
    
    See Also:
    Constant Field Values
  - e_array
```
public static final int e_array
```
    The Constant e_array.
    
    See Also:
    Constant Field Values
  - e_stream
```
public static final int e_stream
```
    The Constant e_stream.
    
    See Also:
    Constant Field Values
- Method Detail
  - getType
```
public int getType()
            throws PDFNetException
```
    Get the Obj type.
    
    Returns:
    the object type.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isBool
```
public boolean isBool()
               throws PDFNetException
```
    Checks if Obj is Boolean object
    
    Returns:
    true if this is a boolean object, false otherwise.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isNumber
```
public boolean isNumber()
                 throws PDFNetException
```
    Checks if Obj is Number object.
    
    Returns:
    true if this is a Number object, false otherwise.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isNull
```
public boolean isNull()
               throws PDFNetException
```
    Checks if is Obj null.
    
    Returns:
    true if this is a Null object, false otherwise.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isString
```
public boolean isString()
                 throws PDFNetException
```
    Checks if Obj is a string object.
    
    Returns:
    true if this is a Str (String) object, false otherwise.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isName
```
public boolean isName()
               throws PDFNetException
```
    Checks if Obj is a name object.
    
    Returns:
    true if this is a Name object, false otherwise.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isIndirect
```
public boolean isIndirect()
                   throws PDFNetException
```
    Checks if Obj is an indirect object
    
    Returns:
    true if this is an Indirect object (i.e. object referenced in the cross-reference table), false otherwise.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isContainer
```
public boolean isContainer()
                    throws PDFNetException
```
    Checks if Obj is a container object.
    
    Returns:
    true if this is a Container (a dictionary, array, or a stream), false otherwise.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isDict
```
public boolean isDict()
               throws PDFNetException
```
    Checks if Obj is dictionary
    
    Returns:
    true if this is a dictionary (i.e. Dict), false otherwise.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isArray
```
public boolean isArray()
                throws PDFNetException
```
    Checks if Obj is an array.
    
    Returns:
    true if this is an Array, false otherwise.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isStream
```
public boolean isStream()
                 throws PDFNetException
```
    Checks if is a stream.
    
    Returns:
    true if this is a Stream, false otherwise.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - getDoc
```
public SDFDoc getDoc()
              throws PDFNetException
```
    Get the Doc object contains this Obj
    
    Returns:
    the document to which this object belongs.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - write
```
public void write(FilterWriter stream)
           throws PDFNetException
```
    The function writes the Obj to the output stream.
    
    Parameters:
    stream - - the input stream where the Obj will be written
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - size
```
public long size()
          throws PDFNetException
```
    Get size of Obj
    
    Returns:
    the 'size' of the object. The definition of 'size' depends on the object type. In particular: - For a dictionary or a stream object, the method will return the number of key/value pairs in the dictionary. - For an array object the method will return the number of Obj enties in the array. - For a string object the method will return the number of bytes in the string buffer. - For any other object the method will always return 1.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - getObjNum
```
public long getObjNum()
               throws PDFNetException
```
    Get the object number.
    
    Returns:
    object number. If this is not an Indirect object, object number of a containing indirect object is returned.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - getGenNum
```
public short getGenNum()
                throws PDFNetException
```
    Get the generation number.
    
    Returns:
    generation number. If this is not an Indirect object, generation number of a containing indirect object is returned.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - getOffset
```
public long getOffset()
               throws PDFNetException
```
    Get the offset from beginning of the file.
    
    Returns:
    object offset from the beginning of the file. If this is not an Indirect object, offset of a containing indirect object is returned.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isFree
```
public boolean isFree()
               throws PDFNetException
```
    Checks if it is marked as free.
    
    Returns:
    true if the object is in use or is marked as free.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - setMark
```
public void setMark(boolean mark)
             throws PDFNetException
```
    Set the object mark. Mark is a boolean value that can be associated with every indirect object. This is especially useful when and object graph should be traversed and an operation should be performed on each node only once.
    
    Parameters:
    mark - the new mark
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isMarked
```
public boolean isMarked()
                 throws PDFNetException
```
    Checks if Obj is marked.
    
    Returns:
    true if the object is marked.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isLoaded
```
public boolean isLoaded()
                 throws PDFNetException
```
    Checks if Obj is loaded.
    
    Returns:
    true if the object is loaded in memory.
    
    Throws:
    
    PDFNetException
    Note:
    
    this method can be invoked on any Obj.
  - isEqual
```
public boolean isEqual(Obj to)
                throws PDFNetException
```
    Checks if is equal to specified object
    
    Parameters:
    to - the to
    
    Returns:
    true if two Obj pointers point to the same object. This method does not compare object content so you should not use this method to compare two (e.g. Number) objects
    
    Throws:
    
    PDFNetException
  - getBool
```
public boolean getBool()
                throws PDFNetException
```
    Get the boolean value if Obj is bool
    
    Returns:
    bool value if this is bool.
    
    Throws:
    
    PDFNetException
  - setBool
```
public void setBool(boolean b)
             throws PDFNetException
```
    Set the boolean value to Obj
    
    Parameters:
    b - - bool value used to set Bool object.
    
    Throws:
    
    PDFNetException
  - getNumber
```
public double getNumber()
                 throws PDFNetException
```
    Get the number value
    
    Returns:
    value, if this is Number.
    
    Throws:
    
    PDFNetException
  - setNumber
```
public void setNumber(double n)
               throws PDFNetException
```
    Set the number value
    
    Parameters:
    n - - value used to set Number object.
    
    Throws:
    
    PDFNetException
  - getBuffer
```
public byte[] getBuffer()
                 throws PDFNetException
```
    Get string buffer
    
    Returns:
    a pointer to the string buffer. Please note that the string may not be NULL terminated and that it may not be represented in ASCII or Unicode encoding. For more information on SDF/Cos String objects, please refer to section 3.2.3 'String Objects' in PDF Reference Manual.
    
    Throws:
    
    PDFNetException
    Note:
    
    if SDF/Cos String object is represented as 'PDF Text' (Section 3.8.1 'Text Strings' in PDF Reference) you can use GetAsPDFText method to obtain Unicode representation of the string., use Size() member function in order to obtain the number of bytes in string buffer.
  - getAsPDFText
```
public java.lang.String getAsPDFText()
                              throws PDFNetException
```
    Convert the SDF/Cos String object to 'PDF Text String' (a Unicode string). PDF Text Strings are not used to represent page content, however they are used in text annotations, bookmark names, article names, document information etc. These strings are encoded in either PDFDocEncoding or Unicode character encoding. For more information on PDF Text Strings, please refer to section 3.8.1 'Text Strings' in PDF Reference.
    
    Returns:
    the as pdf text
    
    Throws:
    
    PDFNetException
    Note:
    
    Not all SDF/Cos String objects are used to represent 'PDF Text'. PDF Reference indicates (on a case by case basis ) where an SDF/Cos String object can be used as 'PDF Text'.
  - setString
```
public void setString(byte[] buf)
               throws PDFNetException
```
    Set the string object value.
    
    Parameters:
    buf - the new string buffer
    
    Throws:
    
    PDFNetException
  - setString
```
public void setString(java.lang.String value)
               throws PDFNetException
```
    Set the string object value.
    
    Parameters:
    value - the new string
    
    Throws:
    
    PDFNetException
  - getName
```
public java.lang.String getName()
                         throws PDFNetException
```
    Get the string representation of the Name object
    
    Returns:
    string representation the Name object.
    
    Throws:
    
    PDFNetException
  - setName
```
public void setName(java.lang.String name)
             throws PDFNetException
```
    Set the name string
    
    Parameters:
    name - - value used to set Name object.
    
    Throws:
    
    PDFNetException
  - getDictIterator
```
public DictIterator getDictIterator()
                             throws PDFNetException
```
    Get the dictionary iterator.
    
    Returns:
    an iterator that addresses the first element in the dictionary.
    
    Throws:
    
    PDFNetException
  - find
```
public DictIterator find(java.lang.String key)
                  throws PDFNetException
```
    Search the dictionary for a given key.
    
    Parameters:
    key - - a key to search for in the dictionary
    
    Returns:
    The iterator to the matching key/value pair or invalid iterator (i.e. itr.hasNext()==fase) if the if the dictionary does not contain the given key.
    
    Throws:
    
    PDFNetException
    Note:
    
    A dictionary entry whose value is Obj::Null is equivalent to an absent entry.
  - findObj
```
public Obj findObj(java.lang.String key)
            throws PDFNetException
```
    Search the dictionary for a given key.
    
    Parameters:
    key - - a key to search for in the dictionary
    
    Returns:
    NULL if the dictionary does not contain the specified key. Otherwise return the corresponding value.
    
    Throws:
    
    PDFNetException
    Note:
    
    A dictionary entry whose value is Obj::Null is equivalent to an absent entry.
  - get
```
public DictIterator get(java.lang.String key)
                 throws PDFNetException
```
    Search the dictionary for a given key and throw an exception if the key is not found.
    
    Parameters:
    key - - a key to search for in the dictionary
    
    Returns:
    Obj::Null object if the value matching specified key is a Obj::Null object. otherwise return the interator to the matching key/value pair.
    
    Throws:
    
    PDFNetException
  - putName
```
public Obj putName(java.lang.String key,
          java.lang.String name)
            throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    name - The value of the Obj::Type::e_name object to be inserted into the dictionary.
    
    Returns:
    A newly created name object.
    
    Throws:
    
    PDFNetException
    Note:
    
    If a dictionary already contains an entry with the same key, the old entry will be deleted and all DictIterators to this entry will be invalidated.
  - putArray
```
public Obj putArray(java.lang.String key)
             throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    
    Returns:
    A newly created array object.
    
    Throws:
    
    PDFNetException
    Note:
    
    If a dictionary already contains an entry with the same key, the old entry will be deleted and all DictIterators to this entry will be invalidated.
  - putBool
```
public Obj putBool(java.lang.String key,
          boolean value)
            throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    value - The value of the Obj::Type::e_bool object to be inserted into the dictionary.
    
    Returns:
    A newly created boolean object.
    
    Throws:
    
    PDFNetException
    Note:
    
    If a dictionary already contains an entry with the same key, the old entry will be deleted and all DictIterators to this entry will be invalidated.
  - putDict
```
public Obj putDict(java.lang.String key)
            throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    
    Returns:
    A newly created dictionary.
    
    Throws:
    
    PDFNetException
    Note:
    
    If a dictionary already contains an entry with the same key, the old entry will be deleted and all DictIterators to this entry will be invalidated.
  - putNumber
```
public Obj putNumber(java.lang.String key,
            double value)
              throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    value - The value of the Obj::Type::e_number object to be inserted into the dictionary.
    
    Returns:
    A newly created number object.
    
    Throws:
    
    PDFNetException
    Note:
    
    If a dictionary already contains an entry with the same key, the old entry will be deleted and all DictIterators to this entry will be invalidated.
  - putString
```
public Obj putString(java.lang.String key,
            java.lang.String value)
              throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    value - The value of the Obj::Type::e_string object to be inserted into the dictionary.
    
    Returns:
    A newly created string object.
    
    Throws:
    
    PDFNetException
    Note:
    
    If a dictionary already contains an entry with the same key, the old entry will be deleted and all DictIterators to this entry will be invalidated.
  - putString
```
public Obj putString(java.lang.String key,
            byte[] value)
              throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    value - The buffer used to set the value of the Obj::Type::e_string object to be inserted into the dictionary.
    
    Returns:
    A newly created string object.
    
    Throws:
    
    PDFNetException
    Note:
    
    If a dictionary already contains an entry with the same key, the old entry will be deleted and all DictIterators to this entry will be invalidated.
  - putText
```
public Obj putText(java.lang.String key,
          java.lang.String value)
            throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    value - The value of the Obj::Type::e_string object to be inserted into the dictionary.
    
    Returns:
    A newly created string object.
    
    Throws:
    
    PDFNetException
    Note:
    
    PutText will create the string object as a 'PDF Text' object., If a dictionary already contains an entry with the same key, the old entry will be deleted and all DictIterators to this entry will be invalidated.
  - putNull
```
public void putNull(java.lang.String key)
             throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    
    Throws:
    
    PDFNetException
    Note:
    
    The effect of calling this method is essentially the same as dict.Erase(key) .
  - put
```
public Obj put(java.lang.String key,
      Obj obj)
        throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    obj - The value to be inserted into the dictionary. If 'obj' is indirect (i.e. is a shared) object it will be inserted by reference, otherwise the object will be cloned and then inserted into the dictionary.
    
    Returns:
    A newly inserted object.
    
    Throws:
    
    PDFNetException
  - putRect
```
public Obj putRect(java.lang.String key,
          double x1,
          double y1,
          double x2,
          double y2)
            throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    x1 - the x1
    y1 - the y1
    x2 - the x2
    y2 - the y2
    
    Returns:
    A newly created array object.
    
    Throws:
    
    PDFNetException
    Note:
    
    If a dictionary already contains an entry with the same key, the old entry will be deleted and all DictIterators to this entry will be invalidated.
  - putMatrix
```
public Obj putMatrix(java.lang.String key,
            Matrix2D value)
              throws PDFNetException
```
    Inserts a pair in the dictionary.
    
    Parameters:
    key - The key of the value to set.
    value - - A matrix used to set the values in an array of six numbers. The resulting array will be inserted into the dictionary.
    
    Returns:
    A newly created array object.
    
    Throws:
    
    PDFNetException
    Note:
    
    If a dictionary already contains an entry with the same key, the old entry will be deleted and all DictIterators to this entry will be invalidated.
  - erase
```
public void erase(java.lang.String key)
           throws PDFNetException
```
    Removes an element in the dictionary that matches the given key.
    
    Parameters:
    key - the key
    
    Throws:
    
    PDFNetException
  - erase
```
public void erase(DictIterator pos)
           throws PDFNetException
```
    Removes an element in the dictionary from specified position.
    
    Parameters:
    pos - the pos
    
    Throws:
    
    PDFNetException
  - rename
```
public boolean rename(java.lang.String old_key,
             java.lang.String new_key)
               throws PDFNetException
```
    Change the key value of a dictionary entry. The key can't be renamed if another key with the same name already exists in the dictionary. In this case Rename returns false.
    
    Parameters:
    old_key - the old_key
    new_key - the new_key
    
    Returns:
    true, if successful
    
    Throws:
    
    PDFNetException
  - getAt
```
public Obj getAt(int index)
          throws PDFNetException
```
    Get the Obj at specified index
    
    Parameters:
    index - - The array element to obtain. The first element in an array has an index of zero.
    
    Returns:
    the at
    
    Throws:
    
    PDFNetException
  - insertName
```
public Obj insertName(int pos,
             java.lang.String name)
               throws PDFNetException
```
    Inserts an Obj::Type::e_name object in the array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    name - The value of the Obj::Type::e_name object to be inserted.
    
    Returns:
    A newly created name object.
    
    Throws:
    
    PDFNetException
  - insertArray
```
public Obj insertArray(int pos)
                throws PDFNetException
```
    Inserts an Obj::Type::e_array object in the array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    
    Returns:
    A newly created array object.
    
    Throws:
    
    PDFNetException
  - insertBool
```
public Obj insertBool(int pos,
             boolean value)
               throws PDFNetException
```
    Inserts an Obj::Type::e_bool object in the array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    value - The value of the Obj::Type::e_bool object to be inserted.
    
    Returns:
    A newly created boolean object.
    
    Throws:
    
    PDFNetException
  - insertDict
```
public Obj insertDict(int pos)
               throws PDFNetException
```
    Inserts an Obj::Type::e_dict object in the array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    
    Returns:
    A newly created dictionary object.
    
    Throws:
    
    PDFNetException
  - insertNumber
```
public Obj insertNumber(int pos,
               double value)
                 throws PDFNetException
```
    Inserts an Obj::Type::e_number object in the array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    value - The value of the Obj::Type::e_number object to be inserted.
    
    Returns:
    A newly created number object.
    
    Throws:
    
    PDFNetException
  - insertString
```
public Obj insertString(int pos,
               java.lang.String value)
                 throws PDFNetException
```
    Inserts an Obj::Type::e_string object in the array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    value - The value of the Obj::Type::e_string object to be inserted.
    
    Returns:
    A newly created string object.
    
    Throws:
    
    PDFNetException
  - insertString
```
public Obj insertString(int pos,
               byte[] value)
                 throws PDFNetException
```
    Inserts an Obj::Type::e_string object in the array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    value - The buffer used to set the value of the Obj::Type::e_string object to be inserted.
    
    Returns:
    A newly created string object.
    
    Throws:
    
    PDFNetException
  - insertText
```
public Obj insertText(int pos,
             java.lang.String value)
               throws PDFNetException
```
    Inserts an Obj::Type::e_string object in the array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    value - The value of the Obj::Type::e_string object to be inserted.
    
    Returns:
    A newly created string object.
    
    Throws:
    
    PDFNetException
    Note:
    
    InsertText will create the string object as a 'PDF Text' object.
  - insertNull
```
public Obj insertNull(int pos)
               throws PDFNetException
```
    Inserts an Obj::Type::e_null object in the array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    
    Returns:
    A newly created null object.
    
    Throws:
    
    PDFNetException
  - insert
```
public Obj insert(int pos,
         Obj obj)
           throws PDFNetException
```
    Inserts an existing Obj in this array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    obj - The value to be inserted into the dictionary. If 'obj' is indirect (i.e. is a shared) object it will be inserted by reference, otherwise the object will be cloned and then inserted.
    
    Returns:
    A newly inserted object.
    
    Throws:
    
    PDFNetException
  - insertRect
```
public Obj insertRect(int pos,
             double x1,
             double y1,
             double x2,
             double y2)
               throws PDFNetException
```
    Inserts an array of 4 numbers in this array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    x1 - the x1
    y1 - the y1
    x2 - the x2
    y2 - the y2
    
    Returns:
    A newly created array object.
    
    Throws:
    
    PDFNetException
  - insertMatrix
```
public Obj insertMatrix(int pos,
               Matrix2D value)
                 throws PDFNetException
```
    Inserts an array of 6 numbers in this array.
    
    Parameters:
    pos - - The location in the array to insert the object . The object is inserted before the specified location. The first element in an array has a pos of zero. If pos >= Array->Length(), appends obj to array.
    value - - A matrix used to set the values in an array of six numbers. The resulting array will be then inserted in this array.
    
    Returns:
    A newly created array object.
    
    Throws:
    
    PDFNetException
  - pushBackName
```
public Obj pushBackName(java.lang.String name)
                 throws PDFNetException
```
    Appends a new Obj::Type::e_name object at the end of the array.
    
    Parameters:
    name - - The value of the Obj::Type::e_name object.
    
    Returns:
    The new array object.
    
    Throws:
    
    PDFNetException
  - pushBackArray
```
public Obj pushBackArray()
                  throws PDFNetException
```
    Appends a new Obj::Type::e_array object at the end of the array.
    
    Returns:
    The new array object.
    
    Throws:
    
    PDFNetException
  - pushBackBool
```
public Obj pushBackBool(boolean value)
                 throws PDFNetException
```
    Appends a new Obj::Type::e_bool object at the end of the array.
    
    Parameters:
    value - the value
    
    Returns:
    The new boolean object.
    
    Throws:
    
    PDFNetException
  - pushBackDict
```
public Obj pushBackDict()
                 throws PDFNetException
```
    Appends a new Obj::Type::e_dict object at the end of the array.
    
    Returns:
    The new dictionary object.
    
    Throws:
    
    PDFNetException
  - pushBackNumber
```
public Obj pushBackNumber(double value)
                   throws PDFNetException
```
    Appends a new Obj::Type::e_number object at the end of the array.
    
    Parameters:
    value - - The value of the Obj::Type::e_number object.
    
    Returns:
    The new number object.
    
    Throws:
    
    PDFNetException
  - pushBackString
```
public Obj pushBackString(java.lang.String value)
                   throws PDFNetException
```
    Appends a new Obj::Type::e_string object at the end of the array.
    
    Parameters:
    value - - The value of the Obj::Type::e_string object.
    
    Returns:
    The new string object.
    
    Throws:
    
    PDFNetException
  - pushBackString
```
public Obj pushBackString(byte[] value)
                   throws PDFNetException
```
    Appends a new Obj::Type::e_string object at the end of the array.
    
    Parameters:
    value - The buffer used to set the value of the Obj::Type::e_string object to be inserted.
    
    Returns:
    The new string object.
    
    Throws:
    
    PDFNetException
  - pushBackText
```
public Obj pushBackText(java.lang.String value)
                 throws PDFNetException
```
    Appends a new Obj::Type::e_string object at the end of the array.
    
    Parameters:
    value - The value of the Obj::Type::e_string object to be inserted.
    
    Returns:
    The new string object.
    
    Throws:
    
    PDFNetException
    Note:
    
    InsertText will create the string object as a 'PDF Text' object.
  - pushBackNull
```
public Obj pushBackNull()
                 throws PDFNetException
```
    Appends a new Obj::Type::e_null object at the end of the array.
    
    Returns:
    The new null object.
    
    Throws:
    
    PDFNetException
  - pushBack
```
public Obj pushBack(Obj obj)
             throws PDFNetException
```
    Appends an existing Obj at the end of the array.
    
    Parameters:
    obj - The value to be inserted into the dictionary. If 'obj' is indirect (i.e. is a shared) object it will be inserted by reference, otherwise the object will be cloned and then appended.
    
    Returns:
    A newly appended object.
    
    Throws:
    
    PDFNetException
  - pushBackRect
```
public Obj pushBackRect(double x1,
               double y1,
               double x2,
               double y2)
                 throws PDFNetException
```
    Appends an array of 4 numbers at the end of the array.
    
    Parameters:
    x1 - the x1
    y1 - the y1
    x2 - the x2
    y2 - the y2
    
    Returns:
    A newly appended array object.
    
    Throws:
    
    PDFNetException
  - pushBackMatrix
```
public Obj pushBackMatrix(Matrix2D value)
                   throws PDFNetException
```
    Appends an array of 6 numbers at the end of the array.
    
    Parameters:
    value - - A matrix used to set the values in an array of six numbers. The resulting array will be then inserted in this array.
    
    Returns:
    A newly appended array object.
    
    Throws:
    
    PDFNetException
  - eraseAt
```
public void eraseAt(int pos)
             throws PDFNetException
```
    Checks whether the position is within the array bounds and then removes it from the array and moves each subsequent element to the slot with the next smaller index and decrements the arrays length by 1.
    
    Parameters:
    pos - the pos
    
    Throws:
    
    PDFNetException
  - getRawStreamLength
```
public long getRawStreamLength()
                        throws PDFNetException
```
    Get the raw stream length.
    
    Returns:
    the length of the raw/encoded stream equal to the Lenght parameter
    
    Throws:
    
    PDFNetException
  - getRawStream
```
public Filter getRawStream(boolean decrypt)
                    throws PDFNetException
```
    Get the raw stream.
    
    Parameters:
    decrypt - - If true decrypt the stream if the stream is encrypted.
    
    Returns:
    - A filter to the encoded stream
    
    Throws:
    
    PDFNetException
  - getDecodedStream
```
public Filter getDecodedStream()
                        throws PDFNetException
```
    Get the decoded stream.
    
    Returns:
    - A filter to the decoded stream
    
    Throws:
    
    PDFNetException
  - setStreamData
```
public void setStreamData(byte[] data,
                 Filter filter_chain)
                   throws PDFNetException
```
    Update a stream object with the new content.
    
    Parameters:
    data - the data
    filter_chain - the filter_chain
    
    Throws:
    
    PDFNetException
  - __Create
```
public static Obj __Create(long impl,
           java.lang.Object ref)
```
  - __GetHandle
```
public long __GetHandle()
```
  - __GetRefHandle
```
public java.lang.Object __GetRefHandle()
```

Class Obj

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

e_null

e_bool

e_number

e_name

e_string

e_dict

e_array

e_stream

Method Detail

getType

isBool

isNumber

isNull

isString

isName

isIndirect

isContainer

isDict

isArray

isStream

getDoc

write

size

getObjNum

getGenNum

getOffset

isFree

setMark

isMarked

isLoaded

isEqual

getBool

setBool

getNumber

setNumber

getBuffer

getAsPDFText

setString

setString

getName

setName

getDictIterator

find

findObj

get

putName

putArray

putBool

putDict

putNumber

putString

putString

putText

putNull

put

putRect

putMatrix

erase

erase

rename

getAt

insertName

insertArray

insertBool

insertDict

insertNumber

insertString

insertString

insertText

insertNull

insert

insertRect

insertMatrix

pushBackName

pushBackArray