001 /* Annotation.java -- Wrapper for a text attribute object
002 Copyright (C) 1998, 1999 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package java.text;
040
041 /**
042 * This class is used as a wrapper for a text attribute object. Annotation
043 * objects are associated with a specific range of text. Changing either
044 * the text range or the underlying text invalidates the object.
045 *
046 * @version 0.0
047 *
048 * @author Aaron M. Renn (arenn@urbanophile.com)
049 */
050 public class Annotation
051 {
052
053 /*
054 * Instance Variables
055 */
056
057 /**
058 * This is the attribute object being wrappered
059 */
060 private Object attrib;
061
062 /*************************************************************************/
063
064 /**
065 * Constructors
066 */
067
068 /**
069 * This method initializes a new instance of <code>Annotation</code> to
070 * wrapper the specified text attribute object.
071 *
072 * @param attrib The text attribute <code>Object</code> to wrapper.
073 */
074 public
075 Annotation(Object attrib)
076 {
077 this.attrib = attrib;
078 }
079
080 /*************************************************************************/
081
082 /*
083 * Instance Variables
084 */
085
086 /**
087 * This method returns the text attribute object this <code>Annotation</code>
088 * instance is wrappering.
089 *
090 * @return The text attribute object for this <code>Annotation</code>.
091 */
092 public Object
093 getValue()
094 {
095 return(attrib);
096 }
097
098 /*************************************************************************/
099
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