attribute.html

API資料大全

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines whether this attribute's values are ordered.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../java/lang/Object.html">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/naming/directory/Attribute.html#remove(int)">remove</A></B>(int&nbsp;ix)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes an attribute value from the ordered list of attribute values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/naming/directory/Attribute.html#remove(java.lang.Object)">remove</A></B>(<A HREF="../../../java/lang/Object.html">Object</A>&nbsp;attrval)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a specified value from the attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../java/lang/Object.html">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/naming/directory/Attribute.html#set(int, java.lang.Object)">set</A></B>(int&nbsp;ix,
    <A HREF="../../../java/lang/Object.html">Object</A>&nbsp;attrVal)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets an attribute value in the ordered list of attribute values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/naming/directory/Attribute.html#size()">size</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the number of values in this attribute.</TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="serialVersionUID"><!-- --></A><H3>
serialVersionUID</H3>
<PRE>
public static final long <B>serialVersionUID</B></PRE>
<DL>
<DD>Use serialVersionUID from JNDI 1.1.1 for interoperability.</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->


<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getAll()"><!-- --></A><H3>
getAll</H3>
<PRE>
public <A HREF="../../../javax/naming/NamingEnumeration.html">NamingEnumeration</A> <B>getAll</B>()
                         throws <A HREF="../../../javax/naming/NamingException.html">NamingException</A></PRE>
<DL>
<DD>Retrieves an enumeration of the attribute's values.
 The behaviour of this enumeration is unspecified
 if the the attribute's values are added, changed,
 or removed while the enumeration is in progress.
 If the attribute values are ordered, the enumeration's items
 will be ordered.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A non-null enumeration of the attribute's values.
 Each element of the enumeration is a possibly null Object. The object's
 class is the class of the attribute value. The element is null
 if the attribute's value is null.
 If the attribute has zero values, an empty enumeration 
 is returned.<DT><B>Throws:</B><DD><CODE><A HREF="../../../javax/naming/NamingException.html">NamingException</A></CODE> - If a naming exception was encountered while retrieving
		the values.<DT><B>See Also: </B><DD><A HREF="../../../javax/naming/directory/Attribute.html#isOrdered()"><CODE>isOrdered()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="get()"><!-- --></A><H3>
get</H3>
<PRE>
public <A HREF="../../../java/lang/Object.html">Object</A> <B>get</B>()
           throws <A HREF="../../../javax/naming/NamingException.html">NamingException</A></PRE>
<DL>
<DD>Retrieves one of this attribute's values.
 If the attribute has more than one value and is unordered, any one of
 the values is returned.
 If the attribute has more than one value and is ordered, the
 first value is returned.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A possibly null object representing one of 
        the attribute's value. It is null if the attribute's value
	       is null.<DT><B>Throws:</B><DD><CODE><A HREF="../../../javax/naming/NamingException.html">NamingException</A></CODE> - If a naming exception was encountered while retrieving
		the value.<DD><CODE><A HREF="../../../java/util/NoSuchElementException.html">NoSuchElementException</A></CODE> - If this attribute has no values.</DL>
</DD>
</DL>
<HR>

<A NAME="size()"><!-- --></A><H3>
size</H3>
<PRE>
public int <B>size</B>()</PRE>
<DL>
<DD>Retrieves the number of values in this attribute.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The nonnegative number of values in this attribute.</DL>
</DD>
</DL>
<HR>

<A NAME="getID()"><!-- --></A><H3>
getID</H3>
<PRE>
public <A HREF="../../../java/lang/String.html">String</A> <B>getID</B>()</PRE>
<DL>
<DD>Retrieves the id of this attribute.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The id of this attribute. It cannot be null.</DL>
</DD>
</DL>
<HR>

<A NAME="contains(java.lang.Object)"><!-- --></A><H3>
contains</H3>
<PRE>
public boolean <B>contains</B>(<A HREF="../../../java/lang/Object.html">Object</A>&nbsp;attrVal)</PRE>
<DL>
<DD>Determines whether a value is in the attribute.
 Equality is determined by the implementation, which may use
 <tt>Object.equals()</tt> or schema information to determine equality.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attrVal</CODE> - The possibly null value to check. If null, check
  whether the attribute has an attribute value whose value is null.<DT><B>Returns:</B><DD>true if attrVal is one of this attribute's values; false otherwise.<DT><B>See Also: </B><DD><A HREF="../../../java/lang/Object.html#equals(java.lang.Object)"><CODE>Object.equals(java.lang.Object)</CODE></A>, 
<A HREF="../../../javax/naming/directory/BasicAttribute.html#equals(java.lang.Object)"><CODE>BasicAttribute.equals(java.lang.Object)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="add(java.lang.Object)"><!-- --></A><H3>
add</H3>
<PRE>
public boolean <B>add</B>(<A HREF="../../../java/lang/Object.html">Object</A>&nbsp;attrVal)</PRE>
<DL>
<DD>Adds a new value to the attribute. 
 If the attribute values are unordered and
 <tt>attrVal</tt> is already in the attribute, this method does nothing.
 If the attribute values are ordered, <tt>attrVal</tt> is added to the end of
 the list of attribute values.
<p>
 Equality is determined by the implementation, which may use
 <tt>Object.equals()</tt> or schema information to determine equality.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attrVal</CODE> - The new possibly null value to add. If null, null
  is added as an attribute value.<DT><B>Returns:</B><DD>true if a value was added; false otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="remove(java.lang.Object)"><!-- --></A><H3>
remove</H3>
<PRE>
public boolean <B>remove</B>(<A HREF="../../../java/lang/Object.html">Object</A>&nbsp;attrval)</PRE>
<DL>
<DD>Removes a specified value from the attribute.
 If <tt>attrval</tt> is not in the attribute, this method does nothing.
 If the attribute values are ordered, the first occurrence of 
 <tt>attrVal</tt> is removed and attribute values at indices greater 
 than the removed
 value are shifted up towards the head of the list (and their indices
 decremented by one).
<p>
 Equality is determined by the implementation, which may use
 <tt>Object.equals()</tt> or schema information to determine equality.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attrval</CODE> - The possibly null value to remove from this attribute.
 If null, remove the attribute value that is null.<DT><B>Returns:</B><DD>true if the value was removed; false otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="clear()"><!-- --></A><H3>
clear</H3>
<PRE>
public void <B>clear</B>()</PRE>
<DL>
<DD>Removes all values from this attribute.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAttributeSyntaxDefinition()"><!-- --></A><H3>
getAttributeSyntaxDefinition</H3>
<PRE>
public <A HREF="../../../javax/naming/directory/DirContext.html">DirContext</A> <B>getAttributeSyntaxDefinition</B>()
                                        throws <A HREF="../../../javax/naming/NamingException.html">NamingException</A></PRE>
<DL>
<DD>Retrieves the syntax definition associated with the attribute.
 An attribute's syntax definition specifies the format
 of the attribute's value(s). Note that this is different from 
 the attribute value's representation as a Java object. Syntax 
 definition refers to the directory's notion of <em>syntax</em>.
<p>
 For example, even though a value might be
 a Java String object, its directory syntax might be "Printable String"