Class PDFDictionary

    • Field Detail

      • entries

        protected java.util.Map<java.lang.String,​java.lang.Object> entries
        the entry map
      • order

        protected java.util.List<java.lang.String> order
        maintains the order of the entries added to the entry map. Whenever you modify "entries", always make sure you adjust this list accordingly.
    • Constructor Detail

      • PDFDictionary

        public PDFDictionary()
        Create a new dictionary object.
      • PDFDictionary

        public PDFDictionary​(PDFObject parent)
        Create a new dictionary object.
        Parameters:
        parent - the object's parent if any
    • Method Detail

      • put

        public void put​(java.lang.String name,
                        java.lang.Object value)
        Puts a new name/value pair.
        Parameters:
        name - the name
        value - the value
      • put

        public void put​(java.lang.String name,
                        int value)
        Puts a new name/value pair.
        Parameters:
        name - the name
        value - the value
      • get

        public java.lang.Object get​(java.lang.String name)
        Returns the value given a name.
        Parameters:
        name - the name of the value
        Returns:
        the value or null, if there's no value with the given name.
      • output

        public int output​(java.io.OutputStream stream)
                   throws java.io.IOException
        Write the PDF represention of this object
        Overrides:
        output in class PDFObject
        Parameters:
        stream - the stream to write the PDF to
        Returns:
        the number of bytes written
        Throws:
        java.io.IOException - if there is an error writing to the stream
      • writeDictionary

        protected void writeDictionary​(java.io.OutputStream out,
                                       java.lang.StringBuilder textBuffer)
                                throws java.io.IOException
        Writes the contents of the dictionary to a StringBuffer.
        Parameters:
        out - the OutputStream (for binary content)
        textBuffer - the text buffer for text output
        Throws:
        java.io.IOException - if an I/O error occurs
      • getChildren

        public static void getChildren​(java.util.Collection<java.lang.Object> values,
                                       java.util.Set<PDFObject> children)
      • keySet

        public java.util.Set<java.lang.String> keySet()
      • containsKey

        public boolean containsKey​(java.lang.String name)
        Parameters:
        name - The key to find in the map.
        Returns:
        true if the map contains this key.
        See Also:
        Map.containsKey(Object)
      • remove

        public void remove​(java.lang.String name)
        Removes the mapping for the specified key
        Parameters:
        name - key whose mapping is to be removed