/usr/share/doc/libplexus-active-collections-java/api/org/codehaus/plexus/collections/ActiveCollection.html is in libplexus-active-collections-java-doc 1.0~beta2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Tue Oct 18 04:31:00 UTC 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
ActiveCollection (Plexus Container-Backed Active Collections 1.0-beta-2 API)
</TITLE>
<META NAME="date" CONTENT="2011-10-18">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ActiveCollection (Plexus Container-Backed Active Collections 1.0-beta-2 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/codehaus/plexus/collections/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ActiveCollection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/codehaus/plexus/collections/AbstractActiveSet.html" title="class in org.codehaus.plexus.collections"><B>PREV CLASS</B></A>
<A HREF="../../../../org/codehaus/plexus/collections/ActiveCollectionManager.html" title="interface in org.codehaus.plexus.collections"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/codehaus/plexus/collections/ActiveCollection.html" target="_top"><B>FRAMES</B></A>
<A HREF="ActiveCollection.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.codehaus.plexus.collections</FONT>
<BR>
Interface ActiveCollection</H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/codehaus/plexus/collections/ActiveList.html" title="interface in org.codehaus.plexus.collections">ActiveList</A>, <A HREF="../../../../org/codehaus/plexus/collections/ActiveMap.html" title="interface in org.codehaus.plexus.collections">ActiveMap</A>, <A HREF="../../../../org/codehaus/plexus/collections/ActiveSet.html" title="interface in org.codehaus.plexus.collections">ActiveSet</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/codehaus/plexus/collections/AbstractActiveList.html" title="class in org.codehaus.plexus.collections">AbstractActiveList</A>, <A HREF="../../../../org/codehaus/plexus/collections/AbstractActiveMap.html" title="class in org.codehaus.plexus.collections">AbstractActiveMap</A>, <A HREF="../../../../org/codehaus/plexus/collections/AbstractActiveSet.html" title="class in org.codehaus.plexus.collections">AbstractActiveSet</A>, <A HREF="../../../../org/codehaus/plexus/collections/DefaultActiveList.html" title="class in org.codehaus.plexus.collections">DefaultActiveList</A>, <A HREF="../../../../org/codehaus/plexus/collections/DefaultActiveMap.html" title="class in org.codehaus.plexus.collections">DefaultActiveMap</A>, <A HREF="../../../../org/codehaus/plexus/collections/DefaultActiveSet.html" title="class in org.codehaus.plexus.collections">DefaultActiveSet</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>ActiveCollection</B></DL>
</PRE>
<P>
Represents a collection-style view of a <CODE>PlexusContainer</CODE> instance, which retrieves a fresh
batch of component elements for each method call. This interface DOES NOT implement <CODE>Collection</CODE>,
since it is used as a common parent for active <CODE>List</CODE>, <CODE>Set</CODE>, and <CODE>Map</CODE>
implementations.
<br/>
<b>NOTE: All active collections are immutable, and will throw an
<CODE>UnsupportedOperationException</CODE> if a mutator method is called.</b>
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>jdcasey</DD>
</DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/collections/ActiveCollection.html#checkedIsEmpty()">checkedIsEmpty</A></B>()</CODE>
<BR>
Same semantics as <CODE>Collection.isEmpty()</CODE> or <CODE>Map.isEmpty()</CODE>, except this method
will throw a <CODE>ComponentLookupException</CODE> if one or more of the elements collected here
fails during lookup.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/collections/ActiveCollection.html#checkedSize()">checkedSize</A></B>()</CODE>
<BR>
Same semantics as <CODE>Collection.size()</CODE> or <CODE>Map.size()</CODE>, except this method
will throw a <CODE>ComponentLookupException</CODE> if one or more of the elements collected here
fails during lookup.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/collections/ActiveCollection.html#getRole()">getRole</A></B>()</CODE>
<BR>
Retrive the role, or type of component, which is collected in the current instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/collections/ActiveCollection.html#isEmpty()">isEmpty</A></B>()</CODE>
<BR>
Same semantics as <CODE>Collection.isEmpty()</CODE> or <CODE>Map.isEmpty()</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/collections/ActiveCollection.html#size()">size</A></B>()</CODE>
<BR>
Same semantics as <CODE>Collection.size()</CODE> or <CODE>Map.size()</CODE>.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getRole()"><!-- --></A><H3>
getRole</H3>
<PRE>
java.lang.String <B>getRole</B>()</PRE>
<DL>
<DD>Retrive the role, or type of component, which is collected in the current instance. The current
collection will only "contain" elements that specify this role in their component definitions.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isEmpty()"><!-- --></A><H3>
isEmpty</H3>
<PRE>
boolean <B>isEmpty</B>()</PRE>
<DL>
<DD>Same semantics as <CODE>Collection.isEmpty()</CODE> or <CODE>Map.isEmpty()</CODE>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="checkedIsEmpty()"><!-- --></A><H3>
checkedIsEmpty</H3>
<PRE>
boolean <B>checkedIsEmpty</B>()
throws org.codehaus.plexus.component.repository.exception.ComponentLookupException</PRE>
<DL>
<DD>Same semantics as <CODE>Collection.isEmpty()</CODE> or <CODE>Map.isEmpty()</CODE>, except this method
will throw a <CODE>ComponentLookupException</CODE> if one or more of the elements collected here
fails during lookup.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.codehaus.plexus.component.repository.exception.ComponentLookupException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="size()"><!-- --></A><H3>
size</H3>
<PRE>
int <B>size</B>()</PRE>
<DL>
<DD>Same semantics as <CODE>Collection.size()</CODE> or <CODE>Map.size()</CODE>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="checkedSize()"><!-- --></A><H3>
checkedSize</H3>
<PRE>
int <B>checkedSize</B>()
throws org.codehaus.plexus.component.repository.exception.ComponentLookupException</PRE>
<DL>
<DD>Same semantics as <CODE>Collection.size()</CODE> or <CODE>Map.size()</CODE>, except this method
will throw a <CODE>ComponentLookupException</CODE> if one or more of the elements collected here
fails during lookup.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>org.codehaus.plexus.component.repository.exception.ComponentLookupException</CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/codehaus/plexus/collections/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ActiveCollection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/codehaus/plexus/collections/AbstractActiveSet.html" title="class in org.codehaus.plexus.collections"><B>PREV CLASS</B></A>
<A HREF="../../../../org/codehaus/plexus/collections/ActiveCollectionManager.html" title="interface in org.codehaus.plexus.collections"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/codehaus/plexus/collections/ActiveCollection.html" target="_top"><B>FRAMES</B></A>
<A HREF="ActiveCollection.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2011. All Rights Reserved.
</BODY>
</HTML>
|