/*
 * The contents of this file are subject to the terms 
 * of the Common Development and Distribution License 
 * (the "License").  You may not use this file except 
 * in compliance with the License.
 * 
 * You can obtain a copy of the license at 
 * glassfish/bootstrap/legal/CDDLv1.0.txt or 
 * https://glassfish.dev.java.net/public/CDDLv1.0.html. 
 * See the License for the specific language governing 
 * permissions and limitations under the License.
 * 
 * When distributing Covered Code, include this CDDL 
 * HEADER in each file and include the License file at 
 * glassfish/bootstrap/legal/CDDLv1.0.txt.  If applicable, 
 * add the following below this CDDL HEADER, with the 
 * fields enclosed by brackets "[]" replaced with your 
 * own identifying information: Portions Copyright [yyyy] 
 * [name of copyright owner]
 */
// Copyright (c) 1998, 2007, Oracle. All rights reserved.  

/* Copyright (c) 2004, 2006, Oracle. All rights reserved.  */
/*
   DESCRIPTION
    <short description of component this file declares/defines>

   PRIVATE CLASSES
    <list of private classes defined - with one-line descriptions>

   NOTES
    <other useful comments, qualifications, etc.>

   MODIFIED    (MM/DD/YY)
    pkrogh      10/07/05 - 
    pkrogh      09/29/05 - 
    gyorke      08/09/05 - gyorke_10-essentials-directory-creation_050808
    dmahar      08/04/05 - 
    pkrogh      08/28/04 - codeformat
    smcritch    05/14/04 - smcritch_refactor_session_read031604
    smcritch    04/25/04 - Creation
 */
package oracle.toplink.essentials.internal.helper;


/**
 * <b>Purpose</b>:Stores the answer to a simple yes/no question.
 * <p>
 * Superior to Boolean in that you can pass it to a method as a parameter,
 * that method sets the value to either true or false, and then see the
 * answer after.
 * <p>
 * I.e. if a method finds the answer to a question while doing some calculations,
 * it can mark the answer so another method doesn't need to do those calculations
 * again just to see what the answer is.
 * <p>
 * I.e. in a method that gets something, might want some clue after as to
 * from where that something was gotten from.
 *
 *  @author  Stephen McRitchie
 *  @since   release specific (what release of product did this appear in)
 */
public class Answer {
    int answer;

    public Answer() {
        answer = FalseUndefinedTrue.Undefined;
    }

    public void setFalse() {
        answer = FalseUndefinedTrue.False;
    }

    public void setTrue() {
        answer = FalseUndefinedTrue.True;
    }

    public void setUndefined() {
        answer = FalseUndefinedTrue.Undefined;
    }

    public boolean isFalse() {
        return (answer == FalseUndefinedTrue.False);
    }

    public boolean isTrue() {
        return (answer == FalseUndefinedTrue.True);
    }

    public boolean isUndefined() {
        return (answer == FalseUndefinedTrue.Undefined);
    }

    public int getAnswer() {
        return answer;
    }
}
