001/* 002 * $Id: MarkedContentInfo.java 4784 2011-03-15 08:33:00Z blowagie $ 003 * 004 * This file is part of the iText (R) project. 005 * Copyright (c) 1998-2011 1T3XT BVBA 006 * Authors: Kevin Day, Bruno Lowagie, Paulo Soares, et al. 007 * 008 * This program is free software; you can redistribute it and/or modify 009 * it under the terms of the GNU Affero General Public License version 3 010 * as published by the Free Software Foundation with the addition of the 011 * following permission added to Section 15 as permitted in Section 7(a): 012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT, 013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 014 * 015 * This program is distributed in the hope that it will be useful, but 016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 017 * or FITNESS FOR A PARTICULAR PURPOSE. 018 * See the GNU Affero General Public License for more details. 019 * You should have received a copy of the GNU Affero General Public License 020 * along with this program; if not, see http://www.gnu.org/licenses or write to 021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 022 * Boston, MA, 02110-1301 USA, or download the license from the following URL: 023 * http://itextpdf.com/terms-of-use/ 024 * 025 * The interactive user interfaces in modified source and object code versions 026 * of this program must display Appropriate Legal Notices, as required under 027 * Section 5 of the GNU Affero General Public License. 028 * 029 * In accordance with Section 7(b) of the GNU Affero General Public License, 030 * a covered work must retain the producer line in every PDF that is created 031 * or manipulated using iText. 032 * 033 * You can be released from the requirements of the license by purchasing 034 * a commercial license. Buying such a license is mandatory as soon as you 035 * develop commercial activities involving the iText software without 036 * disclosing the source code of your own applications. 037 * These activities include: offering paid services to customers as an ASP, 038 * serving PDFs on the fly in a web application, shipping iText with a closed 039 * source product. 040 * 041 * For more information, please contact iText Software Corp. at this 042 * address: sales@itextpdf.com 043 */ 044package com.itextpdf.text.pdf.parser; 045 046import com.itextpdf.text.pdf.PdfDictionary; 047import com.itextpdf.text.pdf.PdfName; 048import com.itextpdf.text.pdf.PdfNumber; 049 050/** 051 * Represents a Marked Content block in a PDF 052 * @since 5.0.2 053 */ 054public class MarkedContentInfo { 055 private final PdfName tag; 056 private final PdfDictionary dictionary; 057 058 public MarkedContentInfo(PdfName tag, PdfDictionary dictionary) { 059 this.tag = tag; 060 this.dictionary = dictionary != null ? dictionary : new PdfDictionary(); // I'd really prefer to make a defensive copy here to make this immutable 061 } 062 063 /** 064 * Get the tag of this marked content 065 * @return the tag of this marked content 066 */ 067 public PdfName getTag(){ 068 return tag; 069 } 070 071 /** 072 * Determine if an MCID is available 073 * @return true if the MCID is available, false otherwise 074 */ 075 public boolean hasMcid(){ 076 return dictionary.contains(PdfName.MCID); 077 } 078 079 /** 080 * Gets the MCID value If the Marked Content contains 081 * an MCID entry, returns that value. Otherwise, a {@link NullPointerException} is thrown. 082 * @return the MCID value 083 * @throws NullPointerException if there is no MCID (see {@link MarkedContentInfo#hasMcid()}) 084 */ 085 public int getMcid(){ 086 PdfNumber id = dictionary.getAsNumber(PdfName.MCID); 087 if (id == null) 088 throw new IllegalStateException("MarkedContentInfo does not contain MCID"); 089 090 return id.intValue(); 091 } 092 093}