libjava/java/text/Annotation.java

   1 /* Annotation.java -- Wrapper for a text attribute object
   2    Copyright (C) 1998, 1999 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 As a special exception, if you link this library with other files to
  22 produce an executable, this library does not by itself cause the
  23 resulting executable to be covered by the GNU General Public License.
  24 This exception does not however invalidate any other reasons why the
  25 executable file might be covered by the GNU General Public License. */
  26
  27
  28 package java.text;
  29
  30 /**
  31   * This class is used as a wrapper for a text attribute object.  Annotation
  32   * objects are associated with a specific range of text.  Changing either
  33   * the text range or the underlying text invalidates the object.
  34   *
  35   * @version 0.0
  36   *
  37   * @author Aaron M. Renn (arenn@urbanophile.com)
  38   */
  39 public class Annotation
  40 {
  41
  42 /*
  43  * Instance Variables
  44  */
  45
  46 /**
  47   * This is the attribute object being wrappered
  48   */
  49 private Object attrib;
  50
  51 /*************************************************************************/
  52
  53 /**
  54   * Constructors
  55   */
  56
  57 /**
  58   * This method initializes a new instance of <code>Annotation</code> to
  59   * wrapper the specified text attribute object.
  60   *
  61   * @param attrib The text attribute <code>Object</code> to wrapper.
  62   */
  63 public
  64 Annotation(Object attrib)
  65 {
  66   this.attrib = attrib;
  67 }
  68
  69 /*************************************************************************/
  70
  71 /*
  72  * Instance Variables
  73  */
  74
  75 /**
  76   * This method returns the text attribute object this <code>Annotation</code>
  77   * instance is wrappering.
  78   *
  79   * @return The text attribute object for this <code>Annotation</code>.
  80   */
  81 public Object
  82 getValue()
  83 {
  84   return(attrib);
  85 }
  86
  87 /*************************************************************************/
  88
  89 /**
  90   * This method returns a <code>String</code> representation of this
  91   * object.
  92   *
  93   * @return This object as a <code>String</code>.
  94   */
  95 public String
  96 toString()
  97 {
  98   return(getClass().getName() + "[value=" + attrib.toString() + "]");
  99 }
 100
 101 } // class Annotation
 102