KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > Header


1 /*
2  * $Id: Header.java 2692 2007-04-17 14:47:07Z blowagie $
3  * $Name$
4  *
5  * Copyright 1999, 2000, 2001, 2002 by Bruno Lowagie.
6  *
7  * The contents of this file are subject to the Mozilla Public License Version 1.1
8  * (the "License"); you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the License.
14  *
15  * The Original Code is 'iText, a free JAVA-PDF library'.
16  *
17  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
18  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
19  * All Rights Reserved.
20  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
21  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
22  *
23  * Contributor(s): all the names of the contributors are added in the source code
24  * where applicable.
25  *
26  * Alternatively, the contents of this file may be used under the terms of the
27  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
28  * provisions of LGPL are applicable instead of those above. If you wish to
29  * allow use of your version of this file only under the terms of the LGPL
30  * License and not to allow others to use your version of this file under
31  * the MPL, indicate your decision by deleting the provisions above and
32  * replace them with the notice and other provisions required by the LGPL.
33  * If you do not delete the provisions above, a recipient may use your version
34  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Library General Public License as published by the Free Software Foundation;
39  * either version 2 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
43  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
44  * details.
45  *
46  * If you didn't download this code from the following link, you should check if
47  * you aren't using an obsolete version:
48  * http://www.lowagie.com/iText/
49  */
50
51 package com.lowagie.text;
52
53 /**
54  * This is an <CODE>Element</CODE> that contains
55  * some userdefined meta information about the document.
56  * <P>
57  * <B>Example:</B>
58  * <BLOCKQUOTE><PRE>
59  * <STRONG>Header header = new Header("inspired by", "William Shakespeare");</STRONG>
60  * </PRE></BLOCKQUOTE>
61  *
62  * @see Element
63  * @see Meta
64  */
65
66 public class Header extends Meta {
67     
68     // membervariables
69
70     /** This is the content of this chunk of text. */
71     private StringBuffer JavaDoc name;
72     
73     // constructors
74
75     /**
76      * Constructs a <CODE>Meta</CODE>.
77      *
78      * @param name the name of the meta-information
79      * @param content the content
80      */
81     
82     public Header(String JavaDoc name, String JavaDoc content) {
83         super(Element.HEADER, content);
84         this.name = new StringBuffer JavaDoc(name);
85     }
86     
87     // methods to retrieve information
88
89     /**
90      * Returns the name of the meta information.
91      *
92      * @return a <CODE>String</CODE>
93      */
94     public String JavaDoc getName() {
95         return name.toString();
96     }
97     
98     // deprecated
99
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 JavaDoc name() {
107         return getName();
108     }
109 }
Popular Tags