1 /* 2 * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 27 package javax.print.attribute; 28 29 import java.io.Serializable; 30 import java.net.URI; 31 32 /** 33 * Class URISyntax is an abstract base class providing the common 34 * implementation of all attributes whose value is a Uniform Resource 35 * Identifier (URI). Once constructed, a URI attribute's value is immutable. 36 * 37 * @author Alan Kaminsky 38 */ 39 public abstract class URISyntax implements Serializable, Cloneable { 40 41 private static final long serialVersionUID = -7842661210486401678L; 42 43 /** 44 * URI value of this URI attribute. 45 * @serial 46 */ 47 private URI uri; 48 49 /** 50 * Constructs a URI attribute with the specified URI. 51 * 52 * @param uri URI. 53 * 54 * @exception NullPointerException 55 * (unchecked exception) Thrown if <CODE>uri</CODE> is null. 56 */ 57 protected URISyntax(URI uri) { 58 this.uri = verify (uri); 59 } 60 61 private static URI verify(URI uri) { 62 if (uri == null) { 63 throw new NullPointerException(" uri is null"); 64 } 65 return uri; 66 } 67 68 /** 69 * Returns this URI attribute's URI value. 70 * @return the URI. 71 */ 72 public URI getURI() { 73 return uri; 74 } 75 76 /** 77 * Returns a hashcode for this URI attribute. 78 * 79 * @return A hashcode value for this object. 80 */ 81 public int hashCode() { 82 return uri.hashCode(); 83 } 84 85 /** 86 * Returns whether this URI attribute is equivalent to the passed in 87 * object. 88 * To be equivalent, all of the following conditions must be true: 89 * <OL TYPE=1> 90 * <LI> 91 * <CODE>object</CODE> is not null. 92 * <LI> 93 * <CODE>object</CODE> is an instance of class URISyntax. 94 * <LI> 95 * This URI attribute's underlying URI and <CODE>object</CODE>'s 96 * underlying URI are equal. 97 * </OL> 98 * 99 * @param object Object to compare to. 100 * 101 * @return True if <CODE>object</CODE> is equivalent to this URI 102 * attribute, false otherwise. 103 */ 104 public boolean equals(Object object) { 105 return(object != null && 106 object instanceof URISyntax && 107 this.uri.equals (((URISyntax) object).uri)); 108 } 109 110 /** 111 * Returns a String identifying this URI attribute. The String is the 112 * string representation of the attribute's underlying URI. 113 * 114 * @return A String identifying this object. 115 */ 116 public String toString() { 117 return uri.toString(); 118 } 119 120 }