001: /*
002: * $Id: Header.java 2692 2007-04-17 14:47:07Z blowagie $
003: * $Name$
004: *
005: * Copyright 1999, 2000, 2001, 2002 by Bruno Lowagie.
006: *
007: * The contents of this file are subject to the Mozilla Public License Version 1.1
008: * (the "License"); you may not use this file except in compliance with the License.
009: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
010: *
011: * Software distributed under the License is distributed on an "AS IS" basis,
012: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
013: * for the specific language governing rights and limitations under the License.
014: *
015: * The Original Code is 'iText, a free JAVA-PDF library'.
016: *
017: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
018: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
019: * All Rights Reserved.
020: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
021: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
022: *
023: * Contributor(s): all the names of the contributors are added in the source code
024: * where applicable.
025: *
026: * Alternatively, the contents of this file may be used under the terms of the
027: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
028: * provisions of LGPL are applicable instead of those above. If you wish to
029: * allow use of your version of this file only under the terms of the LGPL
030: * License and not to allow others to use your version of this file under
031: * the MPL, indicate your decision by deleting the provisions above and
032: * replace them with the notice and other provisions required by the LGPL.
033: * If you do not delete the provisions above, a recipient may use your version
034: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
035: *
036: * This library is free software; you can redistribute it and/or modify it
037: * under the terms of the MPL as stated above or under the terms of the GNU
038: * Library General Public License as published by the Free Software Foundation;
039: * either version 2 of the License, or any later version.
040: *
041: * This library is distributed in the hope that it will be useful, but WITHOUT
042: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
043: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
044: * details.
045: *
046: * If you didn't download this code from the following link, you should check if
047: * you aren't using an obsolete version:
048: * http://www.lowagie.com/iText/
049: */
050:
051: package com.lowagie.text;
052:
053: /**
054: * This is an <CODE>Element</CODE> that contains
055: * some userdefined meta information about the document.
056: * <P>
057: * <B>Example:</B>
058: * <BLOCKQUOTE><PRE>
059: * <STRONG>Header header = new Header("inspired by", "William Shakespeare");</STRONG>
060: * </PRE></BLOCKQUOTE>
061: *
062: * @see Element
063: * @see Meta
064: */
065:
066: public class Header extends Meta {
067:
068: // membervariables
069:
070: /** This is the content of this chunk of text. */
071: private StringBuffer name;
072:
073: // constructors
074:
075: /**
076: * Constructs a <CODE>Meta</CODE>.
077: *
078: * @param name the name of the meta-information
079: * @param content the content
080: */
081:
082: public Header(String name, String content) {
083: super (Element.HEADER, content);
084: this .name = new StringBuffer(name);
085: }
086:
087: // methods to retrieve information
088:
089: /**
090: * Returns the name of the meta information.
091: *
092: * @return a <CODE>String</CODE>
093: */
094: public String getName() {
095: return name.toString();
096: }
097:
098: // deprecated
099:
100: /**
101: * Returns the name of the meta information.
102: *
103: * @return a <CODE>String</CODE>
104: * @deprecated Use {@link #getName()} instead
105: */
106: public String name() {
107: return getName();
108: }
109: }
|