/*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.array;
/**
   <p>Is the container (array, collection, etc.) allowed to be {@code null}?.</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 NullContainer  {
   /**
      <p>{@code null} is acceptable.</p>

    * @see  #BAD
    * @see  #isOk()
    */
   OK,
   /**
      <p>{@code null} is bad.</p>

    * @see  #OK
    * @see  #isBad()
    */
   BAD;
   /**
      <p>Is this {@code NullContainer} equal to {@code OK}?.</p>

    * @return  <code>(this == {@link #OK})</code>
    * @see  #isBad()
    */
   public final boolean isOk()  {
      return  (this == OK);
   }
   /**
      <p>Is this {@code NullContainer} equal to {@code BAD}?.</p>

    * @return  <code>(this == {@link #BAD})</code>
    * @see  #isOk()
    */
   public final boolean isBad()  {
      return  (this == BAD);
   }
   /**
      <p>Get a {@code NullContainer} from an actual boolean.</p>

    * @return  <code>(b ? {@link #OK} : {@link #BAD})</code>
    */
   public static final NullContainer getForBoolean(boolean b)  {
      return  (b ? OK : BAD);
   }
};