Source for javax.naming.spi.ResolveResult

   1: /* ResolveResult.java --
   2:    Copyright (C) 2001, 2004, 2005, 2006  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.naming.spi;
  40: 
  41: import java.io.Serializable;
  42: 
  43: import javax.naming.CompositeName;
  44: import javax.naming.InvalidNameException;
  45: import javax.naming.Name;
  46:  
  47: /**
  48:  * Stores the partial resolution of the name. This class contains the
  49:  * object to which part of the name has been resolved and the remaining,
  50:  * unresolved part of this name. 
  51:  * 
  52:  * @author Warren Levy (warrenl@redhat.com)
  53:  */
  54: 
  55: public class ResolveResult implements Serializable
  56: {
  57:   private static final long serialVersionUID = - 4552108072002407559L;
  58: 
  59:   // Serialized fields.
  60:   /**
  61:    * The object, to that part of the name has been resolved.
  62:    */
  63:   protected Object resolvedObj;
  64:   
  65:   /**
  66:    * The remaining, unresolved part of the name.
  67:    */
  68:   protected Name remainingName;
  69:   
  70:   /**
  71:    * Create the unitialised instance with both parts being null.
  72:    */
  73:   protected ResolveResult()
  74:   {
  75:   }
  76:   
  77:   /**
  78:    * Create the initialised instance
  79:    * 
  80:    * @param resolved the object, to that the name is partially resolved
  81:    * @param remaining the remaining unresolved part of the name.
  82:    */
  83:   public ResolveResult(Object resolved, String remaining)
  84:   {
  85:     if (resolved == null || remaining == null)
  86:       throw new IllegalArgumentException ();
  87:     resolvedObj = resolved;
  88:     remainingName = new CompositeName ();
  89:     try
  90:       {
  91:     remainingName.add (remaining);
  92:       }
  93:     catch (InvalidNameException _)
  94:       {
  95:       }
  96:   }
  97: 
  98:   /**
  99:    * Create the initialised instance
 100:    * 
 101:    * @param resolved the object, to that the name is partially resolved
 102:    * @param remaining the remaining unresolved part of the name.
 103:    */
 104:   public ResolveResult(Object resolved, Name remaining)
 105:   {
 106:     resolvedObj = resolved;
 107:     remainingName = remaining;
 108:   }
 109: 
 110:   /**
 111:    * Get the remaining unresolved part of the name
 112:    * 
 113:    * @return the remaining unresolved part of the name.
 114:    */
 115:   public Name getRemainingName()
 116:   {
 117:     return remainingName;
 118:   }
 119: 
 120:   /**
 121:    * Get the object to that the name was partially resolved
 122:    * 
 123:    * @return the object, to that the name is partially resolved
 124:    */
 125:   public Object getResolvedObj()
 126:   {
 127:     return resolvedObj;
 128:   }
 129:   
 130:   /**
 131:    * Set the remaining unresolved name.
 132:    * 
 133:    * @param name the name being set. The passed parameter is cloned, so the
 134:    *          caller can reuse or modify it after the method returns.
 135:    */
 136:   public void setRemainingName(Name name)
 137:   {
 138:     remainingName = (Name) name.clone();
 139:   }
 140:   
 141:   /**
 142:    * Append the name to the end of the resolved name.
 143:    * 
 144:    * @param name the name to append
 145:    */
 146:   public void appendRemainingName(Name name)
 147:   {
 148:     try
 149:       {
 150:     remainingName.addAll(name);
 151:       }
 152:     catch (InvalidNameException _)
 153:       {
 154:       }
 155:   }
 156: 
 157:   /**
 158:    * Append the name to the end of the resolved name.
 159:    * 
 160:    * @param name the name to append
 161:    */
 162:   public void appendRemainingComponent(String name)
 163:   {
 164:     try
 165:       {
 166:     remainingName.add(name);
 167:       }
 168:     catch (InvalidNameException _)
 169:       {
 170:       }
 171:   }
 172: 
 173:   /**
 174:    * Set the object to that the part of the name has been resolved.
 175:    * 
 176:    * @param obj the object, to that the name has been partially resolved.
 177:    */
 178:   public void setResolvedObj(Object obj)
 179:   {
 180:     resolvedObj = obj;
 181:   }
 182: }