1  // HTMLParser Library $Name: v1_6_20060319 $ - A java-based parser for HTML
  2  // http://sourceforge.org/projects/htmlparser
  3  // Copyright (C) 2004 Somik Raha
  4  //
  5  // Revision Control Information
  6  //
  7  // $Source: /cvsroot/htmlparser/htmlparser/src/org/htmlparser/tags/TitleTag.java,v $
  8  // $Author: derrickoswald $
  9  // $Date: 2005/04/10 23:20:45 $
 10  // $Revision: 1.36 $
 11  //
 12  // This library is free software; you can redistribute it and/or
 13  // modify it under the terms of the GNU Lesser General Public
 14  // License as published by the Free Software Foundation; either
 15  // version 2.1 of the License, or (at your option) any later version.
 16  //
 17  // This library is distributed in the hope that it will be useful,
 18  // but WITHOUT ANY WARRANTY; without even the implied warranty of
 19  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 20  // Lesser General Public License for more details.
 21  //
 22  // You should have received a copy of the GNU Lesser General Public
 23  // License along with this library; if not, write to the Free Software
 24  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 25  //
 26  
 27  package org.htmlparser.tags;
 28  
 29  /**
 30   * A title tag.
 31   */
 32  public class TitleTag extends CompositeTag
 33  {
 34      /**
 35       * The set of names handled by this tag.
 36       */
 37      private static final String[] mIds = new String[] {"TITLE"};
 38  
 39      /**
 40       * The set of tag names that indicate the end of this tag.
 41       */
 42      private static final String[] mEnders = new String[] {"TITLE","BODY"};
 43  
 44      /**
 45       * The set of end tag names that indicate the end of this tag.
 46       */
 47      private static final String[] mEndTagEnders = new String[] {"HEAD", "HTML"};
 48  
 49      /**
 50       * Create a new title tag.
 51       */
 52      public TitleTag ()
 53      {
 54      }
 55  
 56      /**
 57       * Return the set of names handled by this tag.
 58       * @return The names to be matched that create tags of this type.
 59       */
 60      public String[] getIds ()
 61      {
 62          return (mIds);
 63      }
 64  
 65      /**
 66       * Return the set of tag names that cause this tag to finish.
 67       * @return The names of following tags that stop further scanning.
 68       */
 69      public String[] getEnders ()
 70      {
 71          return (mEnders);
 72      }
 73  
 74      /**
 75       * Return the set of end tag names that cause this tag to finish.
 76       * @return The names of following end tags that stop further scanning.
 77       */
 78      public String[] getEndTagEnders ()
 79      {
 80          return (mEndTagEnders);
 81      }
 82  
 83      /**
 84       * Get the title text.
 85       * @return The title.
 86       */
 87      public String getTitle()
 88      {
 89          return toPlainTextString();
 90      }
 91  
 92      /**
 93       * Return a string representation of this tag for debugging.
 94       * @return A string with the text of the title.
 95       */
 96      public String toString()
 97      {
 98          return "TITLE: " + getTitle();
 99      }
100  }