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 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.text;
  40
  41 /**
  42   * This class is used as a wrapper for a text attribute object.  Annotation
  43   * objects are associated with a specific range of text.  Changing either
  44   * the text range or the underlying text invalidates the object.
  45   *
  46   * @version 0.0
  47   *
  48   * @author Aaron M. Renn (arenn@urbanophile.com)
  49   */
  50 public class Annotation
  51 {
  52
  53 /*
  54  * Instance Variables
  55  */
  56
  57 /**
  58   * This is the attribute object being wrappered
  59   */
  60 private Object attrib;
  61
  62 /*************************************************************************/
  63
  64 /**
  65   * Constructors
  66   */
  67
  68 /**
  69   * This method initializes a new instance of <code>Annotation</code> to
  70   * wrapper the specified text attribute object.
  71   *
  72   * @param attrib The text attribute <code>Object</code> to wrapper.
  73   */
  74 public
  75 Annotation(Object attrib)
  76 {
  77   this.attrib = attrib;
  78 }
  79
  80 /*************************************************************************/
  81
  82 /*
  83  * Instance Variables
  84  */
  85
  86 /**
  87   * This method returns the text attribute object this <code>Annotation</code>
  88   * instance is wrappering.
  89   *
  90   * @return The text attribute object for this <code>Annotation</code>.
  91   */
  92 public Object
  93 getValue()
  94 {
  95   return(attrib);
  96 }
  97
  98 /*************************************************************************/
  99
 100 /**
 101   * This method returns a <code>String</code> representation of this
 102   * object.
 103   *
 104   * @return This object as a <code>String</code>.
 105   */
 106 public String
 107 toString()
 108 {
 109   return(getClass().getName() + "[value=" + attrib.toString() + "]");
 110 }
 111
 112 } // class Annotation
 113