001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017:
018: package javax.naming;
019:
020: import java.io.Serializable;
021:
022: import org.apache.harmony.jndi.internal.nls.Messages;
023:
024: /**
025: * <code>NameClassPair</code> associates a name in a naming service with a
026: * specified class name and also with a relative flag. In JNDI,
027: * <code>NameClassPair</code> is extended by <code>javax.naming.Binding</code>;
028: * <code>Binding</code> objects are used in <code>javax.naming.Context</code>
029: * implementations.
030: * <p>
031: * A <code>NameClassPair</code> object is not thread-safe unless appropriate
032: * synchronization is applied to any code manipulating these objects.
033: * </p>
034: * <p>
035: * As this class implements the <code>Serializable</code> interface, it is
036: * important that fields below are declared with the same names.
037: * </p>
038: */
039: public class NameClassPair implements Serializable {
040:
041: private static final long serialVersionUID = 5620776610160863339L;
042:
043: /**
044: * The name used in a naming service. This field may be null and has default
045: * value of null.
046: *
047: * @serial
048: */
049: private String name;
050:
051: /**
052: * The class of an object represented by this name in a naming service. This
053: * field may be null and has default value null.
054: *
055: * @serial
056: */
057: private String className;
058:
059: /**
060: *
061: * @serial
062: */
063: private String fullName;
064:
065: /**
066: * This flag indicates whether the name s used in a naming service is
067: * relative to the context. It is set by setRelative and is not derived.
068: * This field has default value true. If this is set to false then the name
069: * is not relative and is actually a URL.
070: *
071: * @serial
072: */
073: private boolean isRel;
074:
075: /**
076: * Construct a <code>NameClassPair</code> from a name and a class. Both
077: * arguments can be null. Relative flag is true.
078: *
079: * @param name
080: * a name used in naming service
081: * @param className
082: * a class name
083: */
084: public NameClassPair(String name, String className) {
085: this (name, className, true);
086: }
087:
088: /**
089: * Construct a <code>NameClassPair</code> from a name, a class and a
090: * relative flag. The name and class arguments can be null.
091: *
092: * @param name
093: * a name used in naming service
094: * @param className
095: * a class name
096: * @param relative
097: * a relative flag
098: */
099: public NameClassPair(String name, String className, boolean relative) {
100: if (name == null) {
101: // jndi.00=name must not be null
102: throw new IllegalArgumentException(Messages
103: .getString("jndi.00")); //$NON-NLS-1$
104: }
105: this .name = name;
106: this .className = className;
107: this .isRel = relative;
108: this .fullName = null;
109: }
110:
111: /**
112: * Returns the value of the class which may be null.
113: *
114: * @return the value of the class which may be null.
115: */
116: public String getClassName() {
117: return className;
118: }
119:
120: /**
121: * Returns the value of the name field which may be null.
122: *
123: * @return the value of the name field which may be null.
124: */
125: public String getName() {
126: return name;
127: }
128:
129: /**
130: * Returns the value of the relative flag.
131: *
132: * @return the value of the relative flag.
133: */
134: public boolean isRelative() {
135: return isRel;
136: }
137:
138: /**
139: * Set the class of this object. The argument can be null.
140: *
141: * @param className
142: * a class name
143: */
144: public void setClassName(String className) {
145: this .className = className;
146: }
147:
148: /**
149: * Set the name of this object. The argument can be null.
150: *
151: * @param name
152: * a name used in naming service
153: */
154: public void setName(String name) {
155: if (name == null) {
156: // jndi.00=name must not be null
157: throw new IllegalArgumentException(Messages
158: .getString("jndi.00")); //$NON-NLS-1$
159: }
160: this .name = name;
161: }
162:
163: /**
164: * Set the isRelative flag field of this object.
165: *
166: * @param relative
167: * a relative flag
168: */
169: public void setRelative(boolean relative) {
170: this .isRel = relative;
171: }
172:
173: /**
174: * Returns the value of the full name field which may be null.
175: *
176: * @return the value of the full name field which may be null.
177: *
178: * @throws UnsupportedOperationException
179: */
180: public String getNameInNamespace() {
181: if (fullName == null) {
182: // jndi.01=full name doesn't apply to this binding
183: throw new UnsupportedOperationException(Messages
184: .getString("jndi.01")); //$NON-NLS-1$
185: }
186: return fullName;
187: }
188:
189: /**
190: * Set the full name of this object. The argument can be null.
191: *
192: * @param fullName
193: * a full name
194: */
195: public void setNameInNamespace(String fullName) {
196: this .fullName = fullName;
197: }
198:
199: /**
200: * If the flag is set to false then the string is preceded with "(not
201: * relative)" and then has the name value, ": " and the class value.
202: *
203: * @return a string representation of this object
204: */
205: @Override
206: public String toString() {
207: StringBuffer buf = new StringBuffer();
208: if (!isRel) {
209: buf.append("(not relative)"); //$NON-NLS-1$
210: }
211: buf.append(getName());
212: buf.append(": "); //$NON-NLS-1$
213: buf.append(getClassName()); // getClassName() is overridden by subclass
214: return buf.toString();
215: }
216:
217: }
|