Returns.java

/*license*\
   XBN-Java: Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com)

   This software is dual-licensed under the:
   - Lesser General Public License (LGPL) version 3.0 or, at your option, any later version;
   - Apache Software License (ASL) version 2.0.

   Either license may be applied at your discretion. More information may be found at
   - http://en.wikipedia.org/wiki/Multi-licensing.

   The text of both licenses is available in the root directory of this project, under the names "LICENSE_lgpl-3.0.txt" and "LICENSE_asl-2.0.txt". The latest copies may be downloaded at:
   - LGPL 3.0: https://www.gnu.org/licenses/lgpl-3.0.txt
   - ASL 2.0: http://www.apache.org/licenses/LICENSE-2.0.txt
\*license*/
package  com.github.xbn.linefilter;
   import  com.github.xbn.util.EnumUtil;
/**
   <p>What should be returned by the filtered line iterator?.</p>

 * @since  0.1.0
 * @author  Copyright (C) 2014, Jeff Epstein ({@code aliteralmind __DASH__ github __AT__ yahoo __DOT__ com}), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. <a href="http://xbnjava.aliteralmind.com">{@code http://xbnjava.aliteralmind.com}</a>, <a href="https://github.com/aliteralmind/xbnjava">{@code https://github.com/aliteralmind/xbnjava}</a>
 **/
public enum Returns  {
   /**
      <p>YYY.</p>

    * @see  #ACTIVE
    * @see  #ALL
    * @see  #isKept()
    */
   KEPT,
   /**
      <p>YYY.</p>

    * @see  #KEPT
    * @see  #isActive()
    */
   ACTIVE,
   /**
      <p>YYY.</p>

    * @see  #KEPT
    * @see  #isAll()
    */
   ALL;
   /**
      <p>Is this {@code Returns} equal to {@code KEPT}?.</p>

    * @return  <code>this == {@link #KEPT}</code>

    * @see  #isActive()
    * @see  #isAll()
    */
   public final boolean isKept()  {
      return  this == KEPT;
   }
   /**
      <p>Is this {@code Returns} equal to {@code ACTIVE}?.</p>

    * @return  <code>this == {@link #ACTIVE}</code>
    * @see  #isKept()
    */
   public final boolean isActive()  {
      return  this == ACTIVE;
   }
   /**
      <p>Is this {@code Returns} equal to {@code ALL}?.</p>

    * @return  <code>this == {@link #ALL}</code>
    * @see  #isKept()
    */
   public final boolean isAll()  {
      return  this == ALL;
   }
   /**
      <p>If a <code>Returns</code> is not a required value, crash.</p>

    * <p>Equal to
      <br/>     <code>{@link com.github.xbn.util.EnumUtil EnumUtil}.{@link com.github.xbn.util.EnumUtil#crashIfNotRequiredValue(Enum, Enum, String, Object) crashIfNotRequiredValue}(this, e_rqd, s_thisEnumsVarNm, o_xtraInfo)</code></p>
    * @see  #crashIfForbiddenValue(Returns, String, Object) crashIfForbiddenValue(ert,s,o)
    */
   public void crashIfNotRequiredValue(Returns e_rqd, String s_thisEnumsVarNm, Object o_xtraInfo)  {
      EnumUtil.crashIfNotRequiredValue(this, e_rqd, s_thisEnumsVarNm, o_xtraInfo);
   }
   /**
      <p>If a <code>Returns</code> is a forbidden value, crash.</p>

    * <p>Equal to
      <br/>     <code>{@link com.github.xbn.util.EnumUtil EnumUtil}.{@link com.github.xbn.util.EnumUtil#crashIfForbiddenValue(Enum, Enum, String, Object) crashIfForbiddenValue}(this, e_rqd, s_thisEnumsVarNm, o_xtraInfo)</code></p>
    * @see  #crashIfNotRequiredValue(Returns, String, Object) crashIfNotRequiredValue(ert,s,o)
    */
   public void crashIfForbiddenValue(Returns e_rqd, String s_thisEnumsVarNm, Object o_xtraInfo)  {
      EnumUtil.crashIfForbiddenValue(this, e_rqd, s_thisEnumsVarNm, o_xtraInfo);
   }
};