NAME

Boilerplater::Symbol - Abstract base class for Boilerplater symbols.

DESCRIPTION

Boilerplater::Symbol serves as an abstract parent class for entities which may live in the global namespace, such as classes, functions, methods, and variables.

CONSTRUCTOR

    my $symbol = MySymbol->new(
        parcel   => $parcel,      # required
        exposure => $exposure,    # required
    );

• parcel - A Boilerplater::Parcel, or a string that can be used to create/retrieve one.

• exposure - The scope in which the symbol is exposed. Must be 'public', 'parcel', 'private', or 'local'.

OBJECT METHODS

get_parcel set_parcel

Accessors for parcel member var.

get_prefix get_Prefix get_PREFIX

Get a string prefix, delegating to parcel member var.

public parcel private local

    if    ( $sym->public ) { do_x() }
    elsif ( $sym->parcel ) { do_y() }

Indicate whether the symbol matches a given access level.

equals

    do_stuff() if $sym->equals($other_sym);

Returns true if the symbols are "equal", false otherwise.

COPYRIGHT

Copyright 2008-2009 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc.

See KinoSearch version 0.30.