PerforceItemSet.html #2

  • //
  • guest/
  • tjuricek/
  • initializer/
  • docs/
  • javadoc/
  • com/
  • perforce/
  • workshop/
  • tjuricek/
  • initializer/
  • model/
  • PerforceItemSet.html
  • View
  • Commits
  • Open Download .zip Download (19 KB)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_05) on Thu Jun 05 09:36:27 PDT 2014 -->
<title>PerforceItemSet (initializer 0.1.2 API)</title>
<meta name="date" content="2014-06-05">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="PerforceItemSet (initializer 0.1.2 API)";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItem.PerforceItemComparator.html" title="class in com.perforce.workshop.tjuricek.initializer.model"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceTrigger.html" title="class in com.perforce.workshop.tjuricek.initializer.model"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/perforce/workshop/tjuricek/initializer/model/PerforceItemSet.html" target="_top">Frames</a></li>
<li><a href="PerforceItemSet.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.perforce.workshop.tjuricek.initializer.model</div>
<h2 title="Class PerforceItemSet" class="title">Class PerforceItemSet</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.util.AbstractCollection&lt;E&gt;</li>
<li>
<ul class="inheritance">
<li>java.util.AbstractSet&lt;E&gt;</li>
<li>
<ul class="inheritance">
<li>java.util.TreeSet&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItem.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceItem</a>&gt;</li>
<li>
<ul class="inheritance">
<li>com.perforce.workshop.tjuricek.initializer.model.PerforceItemSet</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Cloneable, java.lang.Iterable&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItem.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceItem</a>&gt;, java.util.Collection&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItem.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceItem</a>&gt;, java.util.NavigableSet&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItem.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceItem</a>&gt;, java.util.Set&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItem.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceItem</a>&gt;, java.util.SortedSet&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItem.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceItem</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PerforceItemSet</span>
extends java.util.TreeSet&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItem.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceItem</a>&gt;
implements java.util.SortedSet&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItem.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceItem</a>&gt;</pre>
<div class="block">Creates a sorted order of loaded PerforceItems with several helper accessor
 methods.
 <p/>
 It'll be common for one PerforceItem to depend upon information from another
 item. For example, you probably want to create a client, then later,
 use that client to add files against. This collection will provide access to
 finding those dependent elements quickly.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#com.perforce.workshop.tjuricek.initializer.model.PerforceItemSet">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItemSet.html#PerforceItemSet--">PerforceItemSet</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceChangelist.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceChangelist</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItemSet.html#getChangelists--">getChangelists</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceClient.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceClient</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItemSet.html#getClients--">getClients</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceDepot.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceDepot</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItemSet.html#getDepots--">getDepots</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceTrigger.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceTrigger</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItemSet.html#getTriggers--">getTriggers</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceUser.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceUser</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItemSet.html#getUser-java.lang.String-">getUser</a></span>(java.lang.String&nbsp;login)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceUser.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceUser</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItemSet.html#getUsers--">getUsers</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItemSet.html#hasUser-java.lang.String-">hasUser</a></span>(java.lang.String&nbsp;login)</code>
<div class="block">Checks that a PerforceUser definition exists with the specified login.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.TreeSet">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.util.TreeSet</h3>
<code>add, addAll, ceiling, clear, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, spliterator, subSet, subSet, tailSet, tailSet</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.AbstractSet">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.util.AbstractSet</h3>
<code>equals, hashCode, removeAll</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.AbstractCollection">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.util.AbstractCollection</h3>
<code>containsAll, retainAll, toArray, toArray, toString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.SortedSet">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.SortedSet</h3>
<code>comparator, first, headSet, last, spliterator, subSet, tailSet</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Set">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.Set</h3>
<code>add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Collection">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.Collection</h3>
<code>parallelStream, removeIf, stream</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.Iterable</h3>
<code>forEach</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="PerforceItemSet--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PerforceItemSet</h4>
<pre>public&nbsp;PerforceItemSet()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="hasUser-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasUser</h4>
<pre>public&nbsp;boolean&nbsp;hasUser(java.lang.String&nbsp;login)</pre>
<div class="block">Checks that a PerforceUser definition exists with the specified login.
 Used to help validate data.</div>
</li>
</ul>
<a name="getUsers--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsers</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceUser.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceUser</a>&gt;&nbsp;getUsers()</pre>
</li>
</ul>
<a name="getUser-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</h4>
<pre>public&nbsp;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceUser.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceUser</a>&nbsp;getUser(java.lang.String&nbsp;login)</pre>
</li>
</ul>
<a name="getClients--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClients</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceClient.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceClient</a>&gt;&nbsp;getClients()</pre>
</li>
</ul>
<a name="getChangelists--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChangelists</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceChangelist.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceChangelist</a>&gt;&nbsp;getChangelists()</pre>
</li>
</ul>
<a name="getDepots--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDepots</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceDepot.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceDepot</a>&gt;&nbsp;getDepots()</pre>
</li>
</ul>
<a name="getTriggers--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTriggers</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceTrigger.html" title="class in com.perforce.workshop.tjuricek.initializer.model">PerforceTrigger</a>&gt;&nbsp;getTriggers()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceItem.PerforceItemComparator.html" title="class in com.perforce.workshop.tjuricek.initializer.model"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/perforce/workshop/tjuricek/initializer/model/PerforceTrigger.html" title="class in com.perforce.workshop.tjuricek.initializer.model"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/perforce/workshop/tjuricek/initializer/model/PerforceItemSet.html" target="_top">Frames</a></li>
<li><a href="PerforceItemSet.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
# Change User Description Committed
#2 9172 tjuricek 0.1.2 Added command line execution options and documentation to run the initializer locally.
#1 9165 tjuricek Some documentation framework and a fatjar style distribution for the initializer to run outside of a gradle plugin.

Upped the version to 0.1.2, but this may need some testing before it's really guaranteed to work in standalone mode