Package com.pd4ml.pdf.cos

Class COSDictionary

  • All Implemented Interfaces:
    COSObjectable
    Direct Known Subclasses:
    COSStream
    public class COSDictionary
extends COSBase
    A PDF dictionary object: an unordered (here: insertion-ordered, for deterministic output) map from COSName keys to arbitrary COS values. COSStream is a dictionary plus an associated byte stream, so most of the interesting behavior lives here.

    • Constructor Detail

      • COSDictionary

        public COSDictionary()

    • Method Detail

      • size

        public int size()

      • isEmpty

        public boolean isEmpty()

      • keySet

        public java.util.Set<COSName> keySet()

      • entrySet

        public java.util.Set<java.util.Map.Entry<COSName,​COSBase>> entrySet()

      • containsKey

        public boolean containsKey​(COSName key)

      • containsKey

        public boolean containsKey​(java.lang.String key)

      • getItem

        public COSBase getItem​(COSName key)
        Raw value for key, without resolving an indirect reference.

      • getItem

        public COSBase getItem​(java.lang.String key)

      • getDictionaryObject

        public COSBase getDictionaryObject​(COSName key)
        Value for key with any indirect reference resolved, or null.

      • getDictionaryObject

        public COSBase getDictionaryObject​(java.lang.String key)

      • getDictionaryObject

        public COSBase getDictionaryObject​(COSName... keys)
        Resolves the first of several keys that is present, e.g. getDictionaryObject(COSName.CONTENTS, COSName.getPDFName("Contents_")) for handling multiple historical spellings of the same entry.

      • setItem

        public void setItem​(java.lang.String key,
                    COSBase value)

      • setName

        public void setName​(java.lang.String key,
                    java.lang.String name)

      • setInt

        public void setInt​(java.lang.String key,
                   long value)

      • setFloat

        public void setFloat​(java.lang.String key,
                     float value)

      • setBoolean

        public void setBoolean​(java.lang.String key,
                       boolean value)

      • setString

        public void setString​(java.lang.String key,
                      java.lang.String value)

      • getNameAsString

        public java.lang.String getNameAsString​(java.lang.String key)

      • getInt

        public int getInt​(java.lang.String key,
                  int defaultValue)

      • getLong

        public long getLong​(java.lang.String key,
                    long defaultValue)

      • getFloat

        public float getFloat​(java.lang.String key,
                      float defaultValue)

      • getBoolean

        public boolean getBoolean​(java.lang.String key,
                          boolean defaultValue)

      • getString

        public java.lang.String getString​(java.lang.String key)

      • getDictionary

        public COSDictionary getDictionary​(java.lang.String key)

      • getArray

        public COSArray getArray​(java.lang.String key)

      • getStream

        public COSStream getStream​(java.lang.String key)

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object