/*
  Copyright 2006-2012 Stefano Chizzolini. http://www.pdfclown.org

  Contributors:
    * Stefano Chizzolini (original code developer, http://www.stefanochizzolini.it)

  This file should be part of the source code distribution of "PDF Clown library"
  (the Program): see the accompanying README files for more info.

  This Program is free software; you can redistribute it and/or modify it under the terms
  of the GNU Lesser General Public License as published by the Free Software Foundation;
  either version 3 of the License, or (at your option) any later version.

  This Program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY,
  either expressed or implied; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE. See the License for more details.

  You should have received a copy of the GNU Lesser General Public License along with this
  Program (see README files); if not, go to the GNU website (http://www.gnu.org/licenses/).

  Redistribution and use, with or without modification, are permitted provided that such
  redistributions retain the above copyright notice, license and disclaimer, along with
  this list of conditions.
*/

package org.pdfclown.objects;

import org.pdfclown.bytes.IOutputStream;
import org.pdfclown.files.File;
import org.pdfclown.tokens.Keyword;
import org.pdfclown.util.NotImplementedException;

/**
  PDF boolean object [PDF:1.6:3.2.1].

  @author Stefano Chizzolini (http://www.stefanochizzolini.it)
  @version 0.1.2, 12/21/12
*/
public final class PdfBoolean
  extends PdfSimpleObject<Boolean>
{
  // <class>
  // <static>
  // <fields>
  public static final PdfBoolean False = new PdfBoolean(false);
  public static final PdfBoolean True = new PdfBoolean(true);
  // </fields>

  // <interface>
  // <public>
  /**
    Gets the object equivalent to the given value.
  */
  public static PdfBoolean get(
    Boolean value
    )
  {return value == null ? null : (value ? True : False);}
  // </public>
  // </interface>
  // </static>

  // <dynamic>
  // <constructors>
  private PdfBoolean(
    boolean value
    )
  {setRawValue(value);}
  // </constructors>

  // <interface>
  // <public>
  @Override
  public PdfObject accept(
    IVisitor visitor,
    Object data
    )
  {return visitor.visit(this, data);}

  @Override
  public int compareTo(
    PdfDirectObject obj
    )
  {throw new NotImplementedException();}

  @Override
  public Boolean getValue(
    )
  {return (Boolean)super.getValue();}

  @Override
  public void writeTo(
    IOutputStream stream,
    File context
    )
  {stream.write(getRawValue() ? Keyword.True : Keyword.False);}
  // </public>
  // </interface>
  // </dynamic>
  // </class>
}