001/*license*\
002   Codelet: Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com)
003
004   This software is dual-licensed under the:
005   - Lesser General Public License (LGPL) version 3.0 or, at your option, any later version;
006   - Apache Software License (ASL) version 2.0.
007
008   Either license may be applied at your discretion. More information may be found at
009   - http://en.wikipedia.org/wiki/Multi-licensing.
010
011   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:
012   - LGPL 3.0: https://www.gnu.org/licenses/lgpl-3.0.txt
013   - ASL 2.0: http://www.apache.org/licenses/LICENSE-2.0.txt
014\*license*/
015package  com.github.aliteralmind.codelet.simplesig;
016/**
017   <P>If zero matches, crash?.</P>
018
019   @see  SimpleParamSigSearchTerm#getFirstMatchProt(List, CrashIfZero, CrashIfMoreThanOne) SimpleParamSigSearchTerm#getFirstMatch
020   @since  0.1.0
021   @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://codelet.aliteralmind.com">{@code http://codelet.aliteralmind.com}</A>, <A HREF="https://github.com/aliteralmind/codelet">{@code https://github.com/aliteralmind/codelet}</A>
022 **/
023public enum CrashIfZero  {
024   /**
025      <P>YYY.</P>
026
027      @see  #NO
028      @see  #isYes()
029    **/
030   YES,
031   /**
032      <P>YYY.</P>
033
034      @see  #YES
035      @see  #isNo()
036    **/
037   NO;
038   /**
039      <P>Is this {@code CrashIfZero} equal to {@code YES}?.</P>
040
041      @return  <CODE>this == {@link #YES}</CODE>
042
043      @see  #isNo()
044    **/
045   public final boolean isYes()  {
046      return  this == YES;
047   }
048   /**
049      <P>Is this {@code CrashIfZero} equal to {@code NO}?.</P>
050
051      @return  <CODE>this == {@link #NO}</CODE>
052      @see  #isYes()
053    **/
054   public final boolean isNo()  {
055      return  this == NO;
056   }
057   /**
058      <P>Return {@code CrashIfZero.YES} if the flag is {@code true}, or {@code NO} if {@code false}.</P>
059
060      @return  <CODE>(flag ? {@link #YES} : {@link #NO})</CODE>
061    **/
062   public static final CrashIfZero getForBoolean(boolean flag)  {
063      return  (flag ? YES : NO);
064   }
065};