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>Should the constructor list be immutable?.</p>
018
019 * @see  AllSimpleParamSignatures#newConstructorList(Class, Declared, Sorted) AllSimpleParamSignatures#newConstructorList
020 * @author  Copyright (C) 2014, Jeff Epstein, dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. <code><a href="http://codelet.aliteralmind.com">http://codelet.aliteralmind.com</a></code>, <code><a href="https://github.com/aliteralmind/codelet">https://github.com/aliteralmind/codelet</a></code>
021 **/
022public enum Immutable  {
023   /**
024      <p>YYY.</p>
025
026    * @see  #NO
027    * @see  #isYes()
028    */
029   YES,
030   /**
031      <p>YYY.</p>
032
033    * @see  #YES
034    * @see  #isNo()
035    */
036   NO;
037   /**
038      <p>Is this {@code Immutable} equal to {@code YES}?.</p>
039
040    * @return  <code>this == {@link #YES}</code>
041
042    * @see  #isNo()
043    */
044   public final boolean isYes()  {
045      return  this == YES;
046   }
047   /**
048      <p>Is this {@code Immutable} equal to {@code NO}?.</p>
049
050    * @return  <code>this == {@link #NO}</code>
051    * @see  #isYes()
052    */
053   public final boolean isNo()  {
054      return  this == NO;
055   }
056   /**
057      <p>Return {@code Immutable.YES} if the flag is {@code true}, or {@code NO} if {@code false}.</p>
058
059    * @return  <code>(flag ? {@link #YES} : {@link #NO})</code>
060    */
061   public static final Immutable getForBoolean(boolean flag)  {
062      return  (flag ? YES : NO);
063   }
064};