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.util;
016/**
017   <p>Is the final parameter in a method or constructor an array-ellipsis ({@code "..."})?.</p>
018
019 * @see  JavaDocUtil#getClassNameForParams(Class[], VarArgs) JavaDocUtil#getClassNameForParams
020 * @see  JavaDocUtil#appendClassNameForParams(StringBuilder, Class[], VarArgs) JavaDocUtil#appendClassNameForParams
021 * @since  0.1.0
022 * @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>
023 **/
024public enum VarArgs  {
025   /**
026      <p>YYY.</p>
027
028    * @see  #NO
029    * @see  #isYes()
030    */
031   YES,
032   /**
033      <p>YYY.</p>
034
035    * @see  #YES
036    * @see  #isNo()
037    */
038   NO;
039   /**
040      <p>Is this {@code VarArgs} equal to {@code YES}?.</p>
041
042    * @return  <code>this == {@link #YES}</code>
043
044    * @see  #isNo()
045    */
046   public final boolean isYes()  {
047      return  this == YES;
048   }
049   /**
050      <p>Is this {@code VarArgs} equal to {@code NO}?.</p>
051
052    * @return  <code>this == {@link #NO}</code>
053    * @see  #isYes()
054    */
055   public final boolean isNo()  {
056      return  this == NO;
057   }
058   /**
059      <p>Return {@code VarArgs.YES} if the flag is {@code true}, or {@code NO} if {@code false}.</p>
060
061    * @return  <code>(flag ? {@link #YES} : {@link #NO})</code>
062    */
063   public static final VarArgs getForBoolean(boolean flag)  {
064      return  (flag ? YES : NO);
065   }
066};