1 /*
2 * Copyright 1999 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.naming;
27
28 /**
29 * This class represents the string form of the address of
30 * a communications end-point.
31 * It consists of a type that describes the communication mechanism
32 * and a string contents specific to that communication mechanism.
33 * The format and interpretation of
34 * the address type and the contents of the address are based on
35 * the agreement of three parties: the client that uses the address,
36 * the object/server that can be reached using the address, and the
37 * administrator or program that creates the address.
38 *
39 * <p> An example of a string reference address is a host name.
40 * Another example of a string reference address is a URL.
41 *
42 * <p> A string reference address is immutable:
43 * once created, it cannot be changed. Multithreaded access to
44 * a single StringRefAddr need not be synchronized.
45 *
46 * @author Rosanna Lee
47 * @author Scott Seligman
48 *
49 * @see RefAddr
50 * @see BinaryRefAddr
51 * @since 1.3
52 */
53
54 public class StringRefAddr extends RefAddr {
55 /**
56 * Contains the contents of this address.
57 * Can be null.
58 * @serial
59 */
60 private String contents;
61 /**
62 * Constructs a new instance of StringRefAddr using its address type
63 * and contents.
64 *
65 * @param addrType A non-null string describing the type of the address.
66 * @param addr The possibly null contents of the address in the form of a string.
67 */
68 public StringRefAddr(String addrType, String addr) {
69 super(addrType);
70 contents = addr;
71 }
72
73 /**
74 * Retrieves the contents of this address. The result is a string.
75 *
76 * @return The possibly null address contents.
77 */
78 public Object getContent() {
79 return contents;
80 }
81
82 /**
83 * Use serialVersionUID from JNDI 1.1.1 for interoperability
84 */
85 private static final long serialVersionUID = -8913762495138505527L;
86 }
Save This Page