org.daisy.dotify.api.formatter.TocProperties Maven / Gradle / Ivy

Go to download
package org.daisy.dotify.api.formatter;

/**
 * Defines properties specific for a TOC sequence.
 *
 * @author Joel Håkansson
 */
public class TocProperties extends SequenceProperties {
    /**
     * Defines TOC ranges.
     */
    public enum TocRange {
        /**
         * Defines the TOC range to include the entire document.
         */
        DOCUMENT,
        /**
         * Defines the TOC range to include entries within the volume.
         */
        VOLUME
    }

    ;

    private final String tocName;
    private final TocRange range;

    /**
     * Provides a builder for creating TOC properties instances.
     *
     * @author Joel Håkansson
     */
    public static class Builder extends SequenceProperties.Builder {
        private final String tocName;
        private final TocRange range;

        /**
         * Creates a new builder with the supplied arguments.
         *
         * @param masterName the master identifier
         * @param tocName    the toc identifier
         * @param range      a range for the TOC
         */
        public Builder(String masterName, String tocName, TocRange range) {
            super(masterName);
            this.tocName = tocName;
            this.range = range;
        }

        @Override
        public TocProperties build() {
            return new TocProperties(this);
        }
    }

    private TocProperties(Builder builder) {
        super(builder);
        this.tocName = builder.tocName;
        this.range = builder.range;
    }

    /**
     * Gets the toc identifier.
     *
     * @return returns the toc identifier
     */
    public String getTocName() {
        return tocName;
    }

    /**
     * Gets the toc range.
     *
     * @return returns the toc range
     */
    public TocRange getRange() {
        return range;
    }

}