1 /*
   2  * Copyright (c) 2000, 2017, 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 package javax.print.attribute;
  27 
  28 import java.io.Serializable;
  29 import java.net.URI;
  30 
  31 /**
  32  * Class {@code URISyntax} is an abstract base class providing the common
  33  * implementation of all attributes whose value is a Uniform Resource Identifier
  34  * (URI). Once constructed, a {@code URI} attribute's value is immutable.
  35  *
  36  * @author Alan Kaminsky
  37  */
  38 public abstract class URISyntax implements Serializable, Cloneable {
  39 
  40     /**
  41      * Use serialVersionUID from JDK 1.4 for interoperability.
  42      */
  43     private static final long serialVersionUID = -7842661210486401678L;
  44 
  45     /**
  46      * {@code URI} value of this {@code URI} attribute.
  47      *
  48      * @serial
  49      */
  50     private URI uri;
  51 
  52     /**
  53      * Constructs a {@code URI} attribute with the specified {@code URI}.
  54      *
  55      * @param  uri the {@code URI}
  56      * @throws NullPointerException if {@code uri} is {@code null}
  57      */
  58     protected URISyntax(URI uri) {
  59         this.uri = verify (uri);
  60     }
  61 
  62     private static URI verify(URI uri) {
  63         if (uri == null) {
  64             throw new NullPointerException(" uri is null");
  65         }
  66         return uri;
  67     }
  68 
  69     /**
  70      * Returns this {@code URI} attribute's {@code URI} value.
  71      *
  72      * @return the {@code URI}
  73      */
  74     public URI getURI()  {
  75         return uri;
  76     }
  77 
  78     /**
  79      * Returns a hashcode for this {@code URI} attribute.
  80      *
  81      * @return a hashcode value for this object
  82      */
  83     public int hashCode() {
  84         return uri.hashCode();
  85     }
  86 
  87     /**
  88      * Returns whether this {@code URI} attribute is equivalent to the passed in
  89      * object. To be equivalent, all of the following conditions must be true:
  90      * <ol type=1>
  91      *   <li>{@code object} is not {@code null}.
  92      *   <li>{@code object} is an instance of class {@code URISyntax}.
  93      *   <li>This {@code URI} attribute's underlying {@code URI} and
  94      *   {@code object}'s underlying {@code URI} are equal.
  95      * </ol>
  96      *
  97      * @param  object {@code Object} to compare to
  98      * @return {@code true} if {@code object} is equivalent to this {@code URI}
  99      *         attribute, {@code false} otherwise
 100      */
 101     public boolean equals(Object object) {
 102         return(object != null &&
 103                object instanceof URISyntax &&
 104                this.uri.equals (((URISyntax) object).uri));
 105     }
 106 
 107     /**
 108      * Returns a {@code String} identifying this {@code URI} attribute. The
 109      * {@code String} is the string representation of the attribute's underlying
 110      * {@code URI}.
 111      *
 112      * @return a {@code String} identifying this object
 113      */
 114     public String toString() {
 115         return uri.toString();
 116     }
 117 }