Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.print.attribute

Class TextSyntax

Implemented Interfaces:
Cloneable, Serializable
Known Direct Subclasses:
DetailedStatusMessage, DocumentAccessError, DocumentFormat, DocumentFormatDefault, DocumentFormatSupported, DocumentName, JobDetailedStatusMessages, JobDocumentAccessErrors, JobHoldUntilDefault, JobHoldUntilSupported, JobMessageFromOperator, JobName, JobOriginatingUserName, JobSheetsDefault, JobSheetsSupported, JobStateMessage, MediaDefault, MediaSupported, OutputDeviceAssigned, PrinterInfo, PrinterLocation, PrinterMakeAndModel, PrinterMessageFromOperator, PrinterName, PrinterStateMessage, RequestingUserName, StatusMessage
public abstract class TextSyntax
extends Object
implements Cloneable, Serializable
TextSyntax is the abstract base class of all attribute classes which provide a string as value (e.g. the location of the printer).

A TextSyntax instance consists of a string value and a locale which indicates the language of the locale of the string.

See Also:
Serialized Form

Constructor Summary

TextSyntax(String value, Locale locale)
Creates a TextSyntax object with the given value and locale.

Method Summary

boolean
equals(Object obj)
Tests if the given object is equal to this object.
Locale
getLocale()
Returns the locale of this syntax object.
String
getValue()
Returns the value of this syntax object.
int
hashCode()
Returns the hashcode for this object.
String
toString()
Returns a string representing the object.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TextSyntax

protected TextSyntax(String value,
                     Locale locale)
Creates a TextSyntax object with the given value and locale.
Parameters:
value - the value for this syntax
locale - the locale to use, if null the default locale is used.
Throws:
NullPointerException - if value is null

Method Details

equals

public boolean equals(Object obj)
Tests if the given object is equal to this object.
Overrides:
equals in interface Object
Parameters:
obj - the object to test
Returns:
true if both objects are equal, false otherwise.

getLocale

public Locale getLocale()
Returns the locale of this syntax object.
Returns:
The locale.

getValue

public String getValue()
Returns the value of this syntax object.
Returns:
The value.

hashCode

public int hashCode()
Returns the hashcode for this object.
Overrides:
hashCode in interface Object
Returns:
The hashcode.

toString

public String toString()
Returns a string representing the object. The returned string is the underlying text value of this object.
Overrides:
toString in interface Object
Returns:
The string representation.
TextSyntax.java -- Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About