roleset.html

turbine教程

<A NAME="RoleSet()"><!-- --></A><H3>
RoleSet</H3>
<PRE>
public <B>RoleSet</B>()</PRE>
<DL>
<DD>Constructs an empty RoleSet</DL>
<HR>

<A NAME="RoleSet(java.util.Collection)"><!-- --></A><H3>
RoleSet</H3>
<PRE>
public <B>RoleSet</B>(java.util.Collection&nbsp;roles)</PRE>
<DL>
<DD>Constructs a new RoleSet with specifed contents.

 If the given collection contains multiple objects that are
 identical WRT equals() method, some objects will be overwriten.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roles</CODE> - A collection of roles to be contained in the set.</DL>
</DD>
</DL>

<!-- ============ 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="add(org.apache.turbine.om.security.Role)"><!-- --></A><H3>
add</H3>
<PRE>
public boolean <B>add</B>(<A HREF="../../../../../org/apache/turbine/om/security/Role.html">Role</A>&nbsp;role)</PRE>
<DL>
<DD>Adds a Role to this RoleSet.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>role</CODE> - A Role.<DT><B>Returns:</B><DD>True if Role was added; false if RoleSet already
 contained the Role.</DL>
</DD>
</DL>
<HR>

<A NAME="add(java.util.Collection)"><!-- --></A><H3>
add</H3>
<PRE>
public boolean <B>add</B>(java.util.Collection&nbsp;roles)</PRE>
<DL>
<DD>Adds the Roles in a Collection to this RoleSet.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roles</CODE> - A Collection of Roles.<DT><B>Returns:</B><DD>True if this RoleSet changed as a result; false
 if no change to this RoleSet occurred (this RoleSet
 already contained all members of the added RoleSet).</DL>
</DD>
</DL>
<HR>

<A NAME="add(org.apache.turbine.util.security.RoleSet)"><!-- --></A><H3>
add</H3>
<PRE>
public boolean <B>add</B>(<A HREF="../../../../../org/apache/turbine/util/security/RoleSet.html">RoleSet</A>&nbsp;roleSet)</PRE>
<DL>
<DD>Adds the Roles in another RoleSet to this RoleSet.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roleSet</CODE> - A RoleSet.<DT><B>Returns:</B><DD>True if this RoleSet changed as a result; false if no
 change to this RoleSet occurred (this RoleSet already contained
 all members of the added RoleSet).</DL>
</DD>
</DL>
<HR>

<A NAME="remove(org.apache.turbine.om.security.Role)"><!-- --></A><H3>
remove</H3>
<PRE>
public boolean <B>remove</B>(<A HREF="../../../../../org/apache/turbine/om/security/Role.html">Role</A>&nbsp;role)</PRE>
<DL>
<DD>Removes a Role from this RoleSet.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>role</CODE> - A Role.<DT><B>Returns:</B><DD>True if this RoleSet contained the Role before it was
 removed.</DL>
</DD>
</DL>
<HR>

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

<A NAME="contains(org.apache.turbine.om.security.Role)"><!-- --></A><H3>
contains</H3>
<PRE>
public boolean <B>contains</B>(<A HREF="../../../../../org/apache/turbine/om/security/Role.html">Role</A>&nbsp;role)</PRE>
<DL>
<DD>Checks whether this RoleSet contains a Role.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>role</CODE> - A Role.<DT><B>Returns:</B><DD>True if this RoleSet contains the Role, false
 otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="contains(java.lang.String)"><!-- --></A><H3>
contains</H3>
<PRE>
public boolean <B>contains</B>(java.lang.String&nbsp;roleName)</PRE>
<DL>
<DD>Compares by name a Role with the Roles contained in this
 RoleSet.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roleName</CODE> - Name of Role.<DT><B>Returns:</B><DD>True if argument matched a Role in this RoleSet; false
 if no match.</DL>
</DD>
</DL>
<HR>

<A NAME="getRole(java.lang.String)"><!-- --></A><H3>
getRole</H3>
<PRE>
public <A HREF="../../../../../org/apache/turbine/om/security/Role.html">Role</A> <B>getRole</B>(java.lang.String&nbsp;roleName)</PRE>
<DL>
<DD>Returns a Role with the given name, if it is contained in this
 RoleSet.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roleName</CODE> - Name of Role.<DT><B>Returns:</B><DD>Role if argument matched a Role in this RoleSet; null
 if no match.</DL>
</DD>
</DL>
<HR>

<A NAME="getRolesArray()"><!-- --></A><H3>
getRolesArray</H3>
<PRE>
public <A HREF="../../../../../org/apache/turbine/om/security/Role.html">Role</A>[] <B>getRolesArray</B>()</PRE>
<DL>
<DD>Returns an Roles[] of Roles in this RoleSet.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A Role[].</DL>
</DD>
</DL>
<HR>

<A NAME="elements()"><!-- --></A><H3>
elements</H3>
<PRE>
public java.util.Iterator <B>elements</B>()</PRE>
<DL>
<DD>Returns an Iterator for Roles in this RoleSet.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="size()"><!-- --></A><H3>
size</H3>
<PRE>
public int <B>size</B>()</PRE>
<DL>
<DD>Returns size (cardinality) of this set.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The cardinality of this RoleSet.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RoleSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/turbine/util/security/PermissionSet.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="RoleSet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
Copyright &copy; 2000-2002 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>