jdk/src/java.naming/share/classes/javax/naming/StringRefAddr.java
author chegar
Sun, 17 Aug 2014 15:54:13 +0100
changeset 25859 3317bb8137f4
parent 5506 jdk/src/share/classes/javax/naming/StringRefAddr.java@202f599c92aa
permissions -rw-r--r--
8054834: Modular Source Code Reviewed-by: alanb, chegar, ihse, mduigou Contributed-by: alan.bateman@oracle.com, alex.buckley@oracle.com, chris.hegarty@oracle.com, erik.joelsson@oracle.com, jonathan.gibbons@oracle.com, karen.kinnear@oracle.com, magnus.ihse.bursie@oracle.com, mandy.chung@oracle.com, mark.reinhold@oracle.com, paul.sandoz@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.naming;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * This class represents the string form of the address of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * a communications end-point.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * It consists of a type that describes the communication mechanism
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * and a string contents specific to that communication mechanism.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * The format and interpretation of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * the address type and the contents of the address are based on
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * the agreement of three parties: the client that uses the address,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * the object/server that can be reached using the address, and the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * administrator or program that creates the address.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * <p> An example of a string reference address is a host name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * Another example of a string reference address is a URL.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * <p> A string reference address is immutable:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * once created, it cannot be changed.  Multithreaded access to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * a single StringRefAddr need not be synchronized.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * @author Rosanna Lee
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * @author Scott Seligman
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * @see RefAddr
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * @see BinaryRefAddr
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * @since 1.3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
public class StringRefAddr extends RefAddr {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * Contains the contents of this address.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * Can be null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * @serial
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
    private String contents;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
      * Constructs a new instance of StringRefAddr using its address type
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
      * and contents.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
      *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
      * @param addrType A non-null string describing the type of the address.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
      * @param addr The possibly null contents of the address in the form of a string.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
      */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    public StringRefAddr(String addrType, String addr) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
        super(addrType);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
        contents = addr;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
      * Retrieves the contents of this address. The result is a string.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
      *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
      * @return The possibly null address contents.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
      */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    public Object getContent() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
        return contents;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * Use serialVersionUID from JNDI 1.1.1 for interoperability
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
    private static final long serialVersionUID = -8913762495138505527L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
}