<!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 Wed May 28 15:24:52 PDT 2014 --> <title>ClientSpec (p4java_ext 0.1.0 API)</title> <meta name="date" content="2014-05-28"> <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="ClientSpec (p4java_ext 0.1.0 API)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":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="../../../../../com/perforce/workshop/tjuricek/p4java_ext/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/p4java_ext/ChangeSpec.html" title="class in com.perforce.workshop.tjuricek.p4java_ext"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/DepotSpec.html" title="class in com.perforce.workshop.tjuricek.p4java_ext"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html" target="_top">Frames</a></li> <li><a href="ClientSpec.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../../allclasses-noframe.html">All 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: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </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.p4java_ext</div> <h2 title="Class ClientSpec" class="title">Class ClientSpec</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.perforce.workshop.tjuricek.p4java_ext.ClientSpec</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">ClientSpec</span> extends java.lang.Object</pre> <div class="block">A class that provides a bean-style interface over the client spec map returned by the IOptionsServer map command. The main goal of this class is to deal with funky whitespace issues in the output Map and generating a Spec for input. <p/> A key function is to provide a nice ID for each mapping it ends up seeing. This mostly appends the "ViewX" label to the client name. This is the output of the getView() command. This should basically enable simple "fetch" interface for most values. There should be very little _encoding_ changes, just some tweaks like whitespace trimming etc.</div> </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"> </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/p4java_ext/ClientSpec.html#ClientSpec-java.util.Map-">ClientSpec</a></span>(java.util.Map<java.lang.String,java.lang.Object> clientMap)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#addMapping-java.lang.String-java.lang.String-">addMapping</a></span>(java.lang.String depot, java.lang.String client)</code> <div class="block">Adds a new mapping to the ClientSpec view</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#clearView--">clearView</a></span>()</code> <div class="block">Removes all mappings in the ClientSpec.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#get-java.lang.String-">get</a></span>(java.lang.String key)</code> <div class="block">A lot of values come out of the API with space, etc, appended, so this just makes sure the value is just a normal string, cleaning up most client calls.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Object></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getClientMap--">getClientMap</a></span>()</code> <div class="block">The clientMap is the underlying map *from* the execMap command.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getClientView--">getClientView</a></span>()</code> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getDepotView--">getDepotView</a></span>()</code> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getDescription--">getDescription</a></span>()</code> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getHost--">getHost</a></span>()</code> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getName--">getName</a></span>()</code> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getNonViewOptions--">getNonViewOptions</a></span>()</code> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getOwner--">getOwner</a></span>()</code> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getRoot--">getRoot</a></span>()</code> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String[]></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getView--">getView</a></span>()</code> <div class="block">Converts each "ViewX" row from the map command to a map of the ID to the left and right parts of that mapping.</div> </td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#getViewKeys--">getViewKeys</a></span>()</code> </td> </tr> <tr id="i14" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#put-java.lang.String-java.lang.String-">put</a></span>(java.lang.String key, java.lang.String value)</code> </td> </tr> <tr id="i15" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#setClientMap-java.util.Map-">setClientMap</a></span>(java.util.Map<java.lang.String,java.lang.Object> clientMap)</code> </td> </tr> <tr id="i16" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String d)</code> </td> </tr> <tr id="i17" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#setHost-java.lang.String-">setHost</a></span>(java.lang.String h)</code> </td> </tr> <tr id="i18" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#setName-java.lang.String-">setName</a></span>(java.lang.String n)</code> </td> </tr> <tr id="i19" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#setOwner-java.lang.String-">setOwner</a></span>(java.lang.String s)</code> </td> </tr> <tr id="i20" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html#setRoot-java.lang.String-">setRoot</a></span>(java.lang.String r)</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="ClientSpec-java.util.Map-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ClientSpec</h4> <pre>public ClientSpec(java.util.Map<java.lang.String,java.lang.Object> clientMap)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getClientMap--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getClientMap</h4> <pre>public java.util.Map<java.lang.String,java.lang.Object> getClientMap()</pre> <div class="block">The clientMap is the underlying map *from* the execMap command.</div> </li> </ul> <a name="setClientMap-java.util.Map-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setClientMap</h4> <pre>public void setClientMap(java.util.Map<java.lang.String,java.lang.Object> clientMap)</pre> </li> </ul> <a name="get-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>get</h4> <pre>public java.lang.String get(java.lang.String key)</pre> <div class="block">A lot of values come out of the API with space, etc, appended, so this just makes sure the value is just a normal string, cleaning up most client calls.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>key</code> - The client property, e.g., "Client", "Owner"</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>String value of the property</dd> </dl> </li> </ul> <a name="put-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>put</h4> <pre>public void put(java.lang.String key, java.lang.String value)</pre> </li> </ul> <a name="getName--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getName</h4> <pre>public java.lang.String getName()</pre> </li> </ul> <a name="setName-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setName</h4> <pre>public void setName(java.lang.String n)</pre> </li> </ul> <a name="getRoot--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRoot</h4> <pre>public java.lang.String getRoot()</pre> </li> </ul> <a name="setRoot-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setRoot</h4> <pre>public void setRoot(java.lang.String r)</pre> </li> </ul> <a name="getHost--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getHost</h4> <pre>public java.lang.String getHost()</pre> </li> </ul> <a name="setHost-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setHost</h4> <pre>public void setHost(java.lang.String h)</pre> </li> </ul> <a name="getOwner--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOwner</h4> <pre>public java.lang.String getOwner()</pre> </li> </ul> <a name="setOwner-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setOwner</h4> <pre>public void setOwner(java.lang.String s)</pre> </li> </ul> <a name="getDescription--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDescription</h4> <pre>public java.lang.String getDescription()</pre> </li> </ul> <a name="setDescription-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setDescription</h4> <pre>public void setDescription(java.lang.String d)</pre> </li> </ul> <a name="getView--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getView</h4> <pre>public java.util.Map<java.lang.String,java.lang.String[]> getView()</pre> <div class="block">Converts each "ViewX" row from the map command to a map of the ID to the left and right parts of that mapping. <p/> So say the view has the mapping "\"//depot/x y/...\" //client/x/...". You will get a key value like <code>"View2" -> {"//depot/x y/...", "//client/x/..."}</code>. Note that the enquoting is removed - no decoding is performed at this point though.</div> </li> </ul> <a name="getDepotView--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDepotView</h4> <pre>public java.util.Map<java.lang.String,java.lang.String> getDepotView()</pre> </li> </ul> <a name="getClientView--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getClientView</h4> <pre>public java.util.Map<java.lang.String,java.lang.String> getClientView()</pre> </li> </ul> <a name="getNonViewOptions--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getNonViewOptions</h4> <pre>public java.util.Map<java.lang.String,java.lang.String> getNonViewOptions()</pre> </li> </ul> <a name="clearView--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>clearView</h4> <pre>public void clearView()</pre> <div class="block">Removes all mappings in the ClientSpec.</div> </li> </ul> <a name="addMapping-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>addMapping</h4> <pre>public void addMapping(java.lang.String depot, java.lang.String client)</pre> <div class="block">Adds a new mapping to the ClientSpec view</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>depot</code> - </dd> <dd><code>client</code> - </dd> </dl> </li> </ul> <a name="getViewKeys--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getViewKeys</h4> <pre>public java.util.List<java.lang.String> getViewKeys()</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="../../../../../com/perforce/workshop/tjuricek/p4java_ext/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/p4java_ext/ChangeSpec.html" title="class in com.perforce.workshop.tjuricek.p4java_ext"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../com/perforce/workshop/tjuricek/p4java_ext/DepotSpec.html" title="class in com.perforce.workshop.tjuricek.p4java_ext"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/perforce/workshop/tjuricek/p4java_ext/ClientSpec.html" target="_top">Frames</a></li> <li><a href="ClientSpec.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../../allclasses-noframe.html">All 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: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>