org.toucanpdf.pdf.syntax.PdfName Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of toucanpdf Show documentation

Java library for the creation of PDF files

There is a newer version: 1.0.2

package org.toucanpdf.pdf.syntax;

import org.toucanpdf.model.PdfNameValue;

/**
 * PdfName represents the name object of PDF. Names are used to specify all data within PdfObjects. 
 * 
 * @author Dylan de Wolff
 */
public class PdfName extends AbstractPdfObject {
    private String name;

    /**
     * Creates a new instance of PdfName with the given String.
     * @param name String containing the name.
     */
    public PdfName(String name) {
        super(PdfObjectType.NAME);
        this.setName(name);
    }

    /**
     * creates a new instance of PdfName with the given PdfNameValue.
     * @param name PdfNameValue containing the name.
     * @see PdfNameValue
     */
    public PdfName(PdfNameValue name) {
        super(PdfObjectType.NAME);
        this.setName(name);
    }

    public String getName() {
        return name;
    }

    /**
     * Sets the name and prefixes the name to conform with the PDF.
     * @param name String containing the name.
     */
    public final void setName(String name) {
        this.name = name;
        if (!name.startsWith("/")) {
            this.name = "/" + name;
        }
        this.setByteRepresentation(this.name);
    }

    /**
     * Sets the name of the object.
     * @param name PdfNameValue specifying the name of the object.
     */
    public final void setName(PdfNameValue name) {
        this.setName(name.toString());
    }

    @Override
    public int hashCode() {
        return this.name.hashCode();
    }

    @Override
    public boolean equals(Object o) {
        return o instanceof PdfName && this.name.equals(((PdfName) (o)).getName());
    }
}