001/* 002 * $Id: Header.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: 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; 045 046/** 047 * This is an <CODE>Element</CODE> that contains 048 * some user defined meta information about the document. 049 * <P> 050 * <B>Example:</B> 051 * <BLOCKQUOTE><PRE> 052 * <STRONG>Header header = new Header("inspired by", "William Shakespeare");</STRONG> 053 * </PRE></BLOCKQUOTE> 054 * 055 * @see Element 056 * @see Meta 057 */ 058 059public class Header extends Meta { 060 061 // membervariables 062 063 /** This is the content of this chunk of text. */ 064 private StringBuffer name; 065 066 // constructors 067 068 /** 069 * Constructs a <CODE>Meta</CODE>. 070 * 071 * @param name the name of the meta-information 072 * @param content the content 073 */ 074 075 public Header(String name, String content) { 076 super(Element.HEADER, content); 077 this.name = new StringBuffer(name); 078 } 079 080 // methods to retrieve information 081 082 /** 083 * Returns the name of the meta information. 084 * 085 * @return a <CODE>String</CODE> 086 */ 087 public String getName() { 088 return name.toString(); 089 } 090 091}