/*
* $Id: Chapter.java 3373 2008-05-12 16:21:24Z xlv $
*
* This file is part of the iText project.
* Copyright (c) 1998-2009 1T3XT BVBA
* Authors: Kevin Day, Bruno Lowagie, Paulo Soares, et al.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License version 3
* as published by the Free Software Foundation with the addition of the
* following permission added to Section 15 as permitted in Section 7(a):
* FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
* 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* 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 http://www.gnu.org/licenses or write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA, 02110-1301 USA, or download the license from the following URL:
* http://itextpdf.com/terms-of-use/
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License.
*
* In accordance with Section 7(b) of the GNU Affero General Public License,
* you must retain the producer line in every PDF that is created or manipulated
* using iText.
*
* You can be released from the requirements of the license by purchasing
* a commercial license. Buying such a license is mandatory as soon as you
* develop commercial activities involving the iText software without
* disclosing the source code of your own applications.
* These activities include: offering paid services to customers as an ASP,
* serving PDFs on the fly in a web application, shipping iText with a closed
* source product.
*
* For more information, please contact iText Software Corp. at this
* address: sales@itextpdf.com
*/
package com.itextpdf.text.pdf.parser;
import com.itextpdf.text.pdf.PdfDictionary;
import com.itextpdf.text.pdf.PdfName;
import com.itextpdf.text.pdf.PdfNumber;
/**
* Represents a Marked Content block in a PDF
* @since 5.0.2
*/
public class MarkedContentInfo {
private final PdfName tag;
private final PdfDictionary dictionary;
public MarkedContentInfo(PdfName tag, PdfDictionary dictionary) {
this.tag = tag;
this.dictionary = dictionary != null ? dictionary : new PdfDictionary(); // I'd really prefer to make a defensive copy here to make this immutable
}
/**
* Get the tag of this marked content
* @return the tag of this marked content
*/
public PdfName getTag(){
return tag;
}
/**
* Determine if an MCID is available
* @return true if the MCID is available, false otherwise
*/
public boolean hasMcid(){
return dictionary.contains(PdfName.MCID);
}
/**
* Gets the MCID value If the Marked Content contains
* an MCID entry, returns that value. Otherwise, a {@link NullPointerException} is thrown.
* @return the MCID value
* @throws NullPointerException if there is no MCID (see {@link MarkedContentInfo#hasMcid()})
*/
public int getMcid(){
PdfNumber id = dictionary.getAsNumber(PdfName.MCID);
if (id == null)
throw new IllegalStateException("MarkedContentInfo does not contain MCID");
return id.intValue();
}
}