libjava/javax/naming/directory/BasicAttributes.java

   1 /* BasicAttributes.java --
   2    Copyright (C) 2000, 2001 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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.directory;
  40
  41 import java.util.NoSuchElementException;
  42 import java.util.Vector;
  43 import javax.naming.NamingEnumeration;
  44 import javax.naming.NamingException;
  45
  46 /**
  47  * @author Tom Tromey <tromey@redhat.com>
  48  * @date June 22, 2001
  49  */
  50 public class BasicAttributes implements Attributes
  51 {
  52   private static final long serialVersionUID = 4980164073184639448L;
  53
  54   public BasicAttributes ()
  55   {
  56     this (false);
  57   }
  58
  59   public BasicAttributes (boolean ignoreCase)
  60   {
  61     this.ignoreCase = ignoreCase;
  62     this.attributes = new Vector ();
  63   }
  64
  65   public BasicAttributes (String attrID, Object val)
  66   {
  67     this (attrID, val, false);
  68   }
  69
  70   public BasicAttributes (String attrID, Object val, boolean ignoreCase)
  71   {
  72     this.ignoreCase = ignoreCase;
  73     attributes = new Vector ();
  74     attributes.add (new BasicAttribute (attrID, val));
  75   }
  76
  77   public Object clone ()
  78   {
  79     // Slightly inefficient as we make a garbage Vector here.
  80     BasicAttributes ba = new BasicAttributes (ignoreCase);
  81     ba.attributes = (Vector) attributes.clone ();
  82     return ba;
  83   }
  84
  85   public boolean equals (Object obj)
  86   {
  87     if (! (obj instanceof BasicAttributes))
  88       return false;
  89     BasicAttributes b = (BasicAttributes) obj;
  90     if (ignoreCase != b.ignoreCase
  91         || attributes.size () != b.attributes.size ())
  92       return false;
  93
  94     // Does order matter?
  95     for (int i = 0; i < attributes.size (); ++i)
  96       {
  97         if (! attributes.get (i).equals (b.attributes.get (i)))
  98           return false;
  99       }
 100
 101     return true;
 102   }
 103
 104   public Attribute get (String attrID)
 105   {
 106     for (int i = 0; i < attributes.size (); ++i)
 107       {
 108         Attribute at = (Attribute) attributes.get (i);
 109         if ((ignoreCase && attrID.equalsIgnoreCase (at.getID ()))
 110             || (! ignoreCase && attrID.equals (at.getID ())))
 111           return at;
 112       }
 113
 114     return null;
 115   }
 116
 117   public NamingEnumeration getAll ()
 118   {
 119     return new BasicAttributesEnumeration (false);
 120   }
 121
 122   public NamingEnumeration getIDs ()
 123   {
 124     return new BasicAttributesEnumeration (true);
 125   }
 126
 127   public int hashCode ()
 128   {
 129     int val = 0;
 130     for (int i = 0; i < attributes.size (); ++i)
 131       val += attributes.get (i).hashCode ();
 132     return val;
 133   }
 134
 135   public boolean isCaseIgnored ()
 136   {
 137     return ignoreCase;
 138   }
 139
 140   public Attribute put (Attribute attr)
 141   {
 142     Attribute r = remove (attr.getID ());
 143     attributes.add (attr);
 144     return r;
 145   }
 146
 147   public Attribute put (String attrID, Object val)
 148   {
 149     return put (new BasicAttribute (attrID, val));
 150   }
 151
 152   public Attribute remove (String attrID)
 153   {
 154     for (int i = 0; i < attributes.size (); ++i)
 155       {
 156         Attribute at = (Attribute) attributes.get (i);
 157         if ((ignoreCase && attrID.equalsIgnoreCase (at.getID ()))
 158             || (! ignoreCase && attrID.equals (at.getID ())))
 159           {
 160             attributes.remove (i);
 161             return at;
 162           }
 163       }
 164
 165     return null;
 166   }
 167
 168   public int size ()
 169   {
 170     return attributes.size ();
 171   }
 172
 173   public String toString ()
 174   {
 175     String r = "";
 176     for (int i = 0; i < attributes.size (); ++i)
 177       {
 178         if (i > 0)
 179           r += "; ";
 180         r += attributes.get (i).toString ();
 181       }
 182     return r;
 183   }
 184
 185   // This is set by the serialization spec.
 186   private boolean ignoreCase;
 187   private transient Vector attributes;
 188
 189   // Used when enumerating.
 190   private class BasicAttributesEnumeration implements NamingEnumeration
 191   {
 192     int where = -1;
 193     boolean id;
 194
 195     public BasicAttributesEnumeration (boolean id)
 196     {
 197       this.id = id;
 198     }
 199
 200     public void close () throws NamingException
 201     {
 202     }
 203
 204     public boolean hasMore () throws NamingException
 205     {
 206       return hasMoreElements ();
 207     }
 208
 209     public Object next () throws NamingException
 210     {
 211       return nextElement ();
 212     }
 213
 214     public boolean hasMoreElements ()
 215     {
 216       return where < attributes.size ();
 217     }
 218
 219     public Object nextElement () throws NoSuchElementException
 220     {
 221       if (where + 1 >= attributes.size ())
 222         throw new NoSuchElementException ("no more elements");
 223       ++where;
 224       Attribute at = (Attribute) attributes.get (where);
 225       return id ? (Object) at.getID () : (Object) at;
 226     }
 227   }
 228 }