com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement Maven / Gradle / Ivy

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

There is a newer version: 8.0.3

/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2021 iText Group NV
    Authors: iText Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.commons.actions.sequence;

/**
 * The class allows to make any element identifiable so that it is possible to store some metadata
 * for it.
 */
public abstract class AbstractIdentifiableElement {

    private SequenceId sequenceId;

    /**
     * Obtains an identifier if it was set.
     *
     * @return identifier
     */
    SequenceId getSequenceId() {
        return sequenceId;
    }

    /**
     * Sets an identifier.
     *
     * @param sequenceId is a new identifier for the element
     */
    void setSequenceId(SequenceId sequenceId) {
        this.sequenceId = sequenceId;
    }
}