# ***********************************************
# 
# !!!! DO NOT EDIT !!!!
# 
# This file was auto-generated by Build.PL.
# 
# ***********************************************
# 
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
# 
#     http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

=encoding utf8

=head1 NAME

Clownfish::Boolean - Boolean type.

=head1 SYNOPSIS

    use Clownfish::Boolean qw( $true_singleton $false_singleton );

    my $bool = Clownfish::Boolean->singleton($truth_value);
    my $truth_value = $bool->get_value;

    if ($bool->equals($true_singleton)) {
        print "true\n";
    }

=head1 DESCRIPTION

There are only two singleton instances of this class: C<$true_singleton> and
C<$false_singleton> which are exported on demand.

=head1 CONSTRUCTORS

=head2 singleton

    my $bool = Clownfish::Boolean->singleton($truth_value);

Return either C<$true_singleton> or C<$false_singleton> depending on the
supplied value.

=head1 METHODS

=head2 get_value

    my $bool = $boolean->get_value();

Return the value of the Boolean.

=head2 clone

    my $result = $boolean->clone();

Return a clone of the object.

=head1 INHERITANCE

Clownfish::Boolean isa L<Clownfish::Obj>.

=cut

