site/javadoc/latest/org/apache/edgent/analytics/sensors/Range.html - incubator-retired-edgent-website - Git at Google

 <!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_112) on Mon Dec 18 11:25:20 EST 2017 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>Range (Apache Edgent (incubating) v1.2.0 API)</title>
 <meta name="date" content="2017-12-18">
 <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="Range (Apache Edgent (incubating) v1.2.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="class-use/Range.html">Use</a></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="../../../../../org/apache/edgent/analytics/sensors/Filters.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/edgent/analytics/sensors/Range.html" target="_top">Frames</a></li>
 <li><a href="Range.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&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>Constr&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">org.apache.edgent.analytics.sensors</div>
 <h2 title="Class Range" class="title">Class Range&lt;T extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&gt;</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
 <li>
 <ul class="inheritance">
 <li>org.apache.edgent.analytics.sensors.Range&lt;T&gt;</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - a <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a> value type</dd>
 </dl>
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a>&lt;T&gt;</dd>
 </dl>
 <hr>
 <br>
 <pre>public final class <span class="typeNameLabel">Range&lt;T extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&gt;</span>
 extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
 implements <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a>&lt;T&gt;, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
 <div class="block">A generic immutable range of values and a way to
  check a value for containment in the range.
  <p>
  Useful in filtering in predicates.
  <p>
  A Range consists of a lower and upper endpoint and a <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors"><code>Range.BoundType</code></a>
  for each endpoint.
  <p>
  <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html#CLOSED"><code>Range.BoundType.CLOSED</code></a> includes the endpoint's value in the range and
  is represented as "[" or "]" in the string form for a lower and upper bound
  type respectively.
  <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html#OPEN"><code>Range.BoundType.OPEN</code></a> excludes the endpoint's value in the range and
  is represented as "(" or ")" in the string form for a lower and upper bound
  type respectively.  e.g. <code>"[2..5)"</code>
  <p>
  Typically, the convenience methods in <a href="../../../../../org/apache/edgent/analytics/sensors/Ranges.html" title="class in org.apache.edgent.analytics.sensors"><code>Ranges</code></a> are used to
  construct a Range.
  <p>
  <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#contains-T-"><code>contains()</code></a> is used to check for containment:
  e.g.
  <pre><code>
  Ranges.closed(2,4).contains(2);    // returns true
  Ranges.open(2,4).contains(2);      // returns false
  Ranges.atLeast(2).contains(2);     // returns true
  Ranges.greaterThan(2).contains(2); // returns false
  Ranges.atMost(2).contains(2);      // returns true
  Ranges.lessThan(2).contains(2);    // returns false
  </code></pre>

  <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#toString--"><code>toString()</code></a> yields a convenient string representation and a
  Range may be created from the string representation.
  <pre><code>
  String s = Ranges.closed(2,4).toString(); // yields "[2..4]"
  Range&lt;Integer&gt; range = Ranges.valueOfInteger(s); // yields a Range&lt;Integer&gt;(2,4)
  </code></pre>
  <p>
  Range works with Gson (<code>new Gson().toJson(Range&lt;T&gt;)</code>.
  As as documented by Gson, for generic types you must use
  <code>Gson.fromJson(String, java.lang.reflect.Type)</code> to
  create a Range from its json.
  <p>
  Sample use in a TStream context:
  <pre><code>
  TStream&lt;JsonObject&gt; jStream = ...;
  TStream&lt;JsonObject&gt; filtered = Filters.deadband(jStream,
                      json -&gt; json.getProperty("pressureReading").asInteger(),
                      Ranges.closed(10, 30));
  </code></pre></div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../serialized-form.html#org.apache.edgent.analytics.sensors.Range">Serialized Form</a></dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="nested.class.summary">
 <!--   -->
 </a>
 <h3>Nested Class Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
 <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Class and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static class&nbsp;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a></span></code>
 <div class="block">Exclude or include an endpoint value in the range.</div>
 </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#contains-T-">contains</a></span>(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>&nbsp;v)</code>
 <div class="block">Determine if the Region contains the value.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#contains-T-java.util.Comparator-">contains</a></span>(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>&nbsp;v,
         <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>&gt;&nbsp;cmp)</code>
 <div class="block">Determine if the Region contains the value.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</code>
 <div class="block">Returns true if o is a Range having equal endpoints and bound types to this Range.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#hasLowerEndpoint--">hasLowerEndpoint</a></span>()</code>&nbsp;</td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#hasUpperEndpoint--">hasUpperEndpoint</a></span>()</code>&nbsp;</td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#lowerBoundType--">lowerBoundType</a></span>()</code>
 <div class="block">Get the BoundType for the lowerEndpoint.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#lowerEndpoint--">lowerEndpoint</a></span>()</code>
 <div class="block">Get the range's lower endpoint.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>static &lt;T extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&gt;<br><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a>&lt;T&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#range-T-org.apache.edgent.analytics.sensors.Range.BoundType-T-org.apache.edgent.analytics.sensors.Range.BoundType-">range</a></span>(T&nbsp;lowerEndpoint,
      <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>&nbsp;lbt,
      T&nbsp;upperEndpoint,
      <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>&nbsp;ubt)</code>
 <div class="block">Create a new Range&lt;T&gt;</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#test-T-">test</a></span>(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>&nbsp;value)</code>
 <div class="block">Predicate.test() implementation.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#toString--">toString</a></span>()</code>
 <div class="block">Yields <code>"&lt;lowerBoundType&gt;&lt;lowerEndpoint&gt;..&lt;upperEndpoint&gt;&lt;upperBoundType&gt;"</code>.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#toStringUnsigned--">toStringUnsigned</a></span>()</code>
 <div class="block">Return a String treating the endpoints as an unsigned value.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#upperBoundType--">upperBoundType</a></span>()</code>
 <div class="block">Get the BoundType for the upperEndpoint.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#upperEndpoint--">upperEndpoint</a></span>()</code>
 <div class="block">Get the range's upper endpoint.</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code>static &lt;T extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&gt;<br><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a>&lt;T&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#valueOf-java.lang.String-org.apache.edgent.function.Function-">valueOf</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toStringValue,
        <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,T&gt;&nbsp;fromString)</code>
 <div class="block">Create a Range from a String produced by toString().</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
 <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="range-java.lang.Comparable-org.apache.edgent.analytics.sensors.Range.BoundType-java.lang.Comparable-org.apache.edgent.analytics.sensors.Range.BoundType-">
 <!--   -->
 </a><a name="range-T-org.apache.edgent.analytics.sensors.Range.BoundType-T-org.apache.edgent.analytics.sensors.Range.BoundType-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>range</h4>
 <pre>public static&nbsp;&lt;T extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&gt;&nbsp;<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a>&lt;T&gt;&nbsp;range(T&nbsp;lowerEndpoint,
                                                        <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>&nbsp;lbt,
                                                        T&nbsp;upperEndpoint,
                                                        <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>&nbsp;ubt)</pre>
 <div class="block">Create a new Range&lt;T&gt;
  <p>
  See <a href="../../../../../org/apache/edgent/analytics/sensors/Ranges.html" title="class in org.apache.edgent.analytics.sensors"><code>Ranges</code></a> for a collection of convenience constructors.
  <p>
  While not enforced, for a Range to be useful/sensible,
  the following must be true: <code>lowerEndpoint &lt;= upperEndpoint</code>.
  Otherwise the Range will be returned but test() and contains()
  can never return true.</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - a Comparable type</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>lowerEndpoint</code> - null for an infinite value (and lbt must be OPEN)</dd>
 <dd><code>lbt</code> - <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors"><code>Range.BoundType</code></a> for the lowerEndpoint</dd>
 <dd><code>upperEndpoint</code> - null for an infinite value (and ubt must be OPEN)</dd>
 <dd><code>ubt</code> - <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors"><code>Range.BoundType</code></a> for the upperEndpoint</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the Range</dd>
 </dl>
 </li>
 </ul>
 <a name="equals-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>equals</h4>
 <pre>public&nbsp;boolean&nbsp;equals(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</pre>
 <div class="block">Returns true if o is a Range having equal endpoints and bound types to this Range.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="hashCode--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>hashCode</h4>
 <pre>public&nbsp;int&nbsp;hashCode()</pre>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="hasLowerEndpoint--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>hasLowerEndpoint</h4>
 <pre>public&nbsp;boolean&nbsp;hasLowerEndpoint()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true iff the Range's lower endpoint isn't unbounded/infinite</dd>
 </dl>
 </li>
 </ul>
 <a name="lowerEndpoint--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>lowerEndpoint</h4>
 <pre>public&nbsp;<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>&nbsp;lowerEndpoint()</pre>
 <div class="block">Get the range's lower endpoint.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the endpoint</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if hasLowerEndpoint()==false</dd>
 </dl>
 </li>
 </ul>
 <a name="hasUpperEndpoint--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>hasUpperEndpoint</h4>
 <pre>public&nbsp;boolean&nbsp;hasUpperEndpoint()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true iff the Range's upper endpoint isn't unbounded/infinite</dd>
 </dl>
 </li>
 </ul>
 <a name="upperEndpoint--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>upperEndpoint</h4>
 <pre>public&nbsp;<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>&nbsp;upperEndpoint()</pre>
 <div class="block">Get the range's upper endpoint.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the endpoint</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if hasUpperEndpoint()==false</dd>
 </dl>
 </li>
 </ul>
 <a name="lowerBoundType--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>lowerBoundType</h4>
 <pre>public&nbsp;<a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>&nbsp;lowerBoundType()</pre>
 <div class="block">Get the BoundType for the lowerEndpoint.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the BoundType</dd>
 </dl>
 </li>
 </ul>
 <a name="upperBoundType--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>upperBoundType</h4>
 <pre>public&nbsp;<a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>&nbsp;upperBoundType()</pre>
 <div class="block">Get the BoundType for the upperEndpoint.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the BoundType</dd>
 </dl>
 </li>
 </ul>
 <a name="contains-java.lang.Comparable-java.util.Comparator-">
 <!--   -->
 </a><a name="contains-T-java.util.Comparator-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>contains</h4>
 <pre>public&nbsp;boolean&nbsp;contains(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>&nbsp;v,
                         <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>&gt;&nbsp;cmp)</pre>
 <div class="block">Determine if the Region contains the value.
  <p>
  <code>contains(v)</code> typically suffices.  This
  can be used in cases where it isn't sufficient.
  E.g., for unsigned byte comparisons
  <pre>
  Comparator&lt;Byte&gt; unsignedByteComparator = new Comparator&lt;Byte&gt;() {
      public int compare(Byte b1, Byte b2) {
          return intCompareUnsigned(byteToUnsignedInt(b1), byteToUnsignedInt(b2));
      }
      public boolean equals(Object o2) { return o2==this; }
      };
  Range&lt;Byte&gt; unsignedByteRange = Ranges.valueOfByte("[0..255]");
  unsignedByteRange.contains(byteValue, unsignedByteComparator);
  </pre></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>v</code> - the value to check for containment</dd>
 <dd><code>cmp</code> - the Comparator to use</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the Region contains the value</dd>
 </dl>
 </li>
 </ul>
 <a name="contains-java.lang.Comparable-">
 <!--   -->
 </a><a name="contains-T-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>contains</h4>
 <pre>public&nbsp;boolean&nbsp;contains(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>&nbsp;v)</pre>
 <div class="block">Determine if the Region contains the value.
  <p>
  The Comparable's compareTo() is used for the comparisons.
  <p></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>v</code> - the value to check for containment</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the Region contains the value</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#contains-T-java.util.Comparator-"><code>contains(Comparable, Comparator)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="test-java.lang.Comparable-">
 <!--   -->
 </a><a name="test-T-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>test</h4>
 <pre>public&nbsp;boolean&nbsp;test(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>&nbsp;value)</pre>
 <div class="block">Predicate.test() implementation. Identical to contains(value).</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../org/apache/edgent/function/Predicate.html#test-T-">test</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a>&lt;<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&gt;</code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>value</code> - Value to be tested.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>True if this predicate is true for <code>value</code> otherwise false.</dd>
 </dl>
 </li>
 </ul>
 <a name="valueOf-java.lang.String-org.apache.edgent.function.Function-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>valueOf</h4>
 <pre>public static&nbsp;&lt;T extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&gt;&nbsp;<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a>&lt;T&gt;&nbsp;valueOf(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toStringValue,
                                                          <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,T&gt;&nbsp;fromString)</pre>
 <div class="block">Create a Range from a String produced by toString().
  <p>
  See <a href="../../../../../org/apache/edgent/analytics/sensors/Ranges.html" title="class in org.apache.edgent.analytics.sensors"><code>Ranges</code></a> for a collection of valueOf methods
  for several types of <code>T</code>.</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - a Comparable type</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>toStringValue</code> - value from toString() or has the same syntax.</dd>
 <dd><code>fromString</code> - function to create a T from its String value from
         the parsed toStringValue.  Should throw an IllegalArgumentException
         if unable to perform the conversion.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the Range</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if unable to parse or convert to
          endpoint in toStringValue to a T.</dd>
 </dl>
 </li>
 </ul>
 <a name="toString--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>toString</h4>
 <pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
 <div class="block">Yields <code>"&lt;lowerBoundType&gt;&lt;lowerEndpoint&gt;..&lt;upperEndpoint&gt;&lt;upperBoundType&gt;"</code>.
  <p>
  lowerBoundType is either "[" or "(" for BoundType.CLOSED or OPEN respectively.
  upperBoundType is either "]" or ")" for BoundType.CLOSED or OPEN respectively.
  <p>
  The endpoint value "*" is used to indicate an infinite value.
  Otherwise, endpoint.toString() is used to get the endpoint's value.
  <p>
  Likely yields an undesirable result when wanting to treat
  a Byte, Short, Integer, or Long T in an unsigned fashion.
  See toStringUnsigned().
  <p>
  No special processing is performed to escape/encode a "." present
  in an endpoint.toString() value.  Hence Range&lt;T&gt;.toString() for
  a <code>T</code> of <code>String</code> (of value "." or with embedded ".."),
  or some other non-numeric type may yield values that are not amenable
  to parsing by <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#valueOf-java.lang.String-org.apache.edgent.function.Function-"><code>valueOf(String, Function)</code></a>.
  <br>
  .e.g.,
  <pre>
  "[120..156)"  // lowerEndpoint=120 inclusive, upperEndpoint=156 exclusive
  "[120..*)"    // an "atLeast" 120 range
  </pre></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="toStringUnsigned--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>toStringUnsigned</h4>
 <pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toStringUnsigned()</pre>
 <div class="block">Return a String treating the endpoints as an unsigned value.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>String with same form as <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#toString--"><code>toString()</code></a></dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the Range is not one of
          Byte, Short, Integer, Long</dd>
 </dl>
 </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="class-use/Range.html">Use</a></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="../../../../../org/apache/edgent/analytics/sensors/Filters.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/edgent/analytics/sensors/Range.html" target="_top">Frames</a></li>
 <li><a href="Range.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&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>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>