Enum

new

  my $obj = Object::Enum->new(\@values);
  # or
  $obj = Object::Enum->new(\%arg);

Return a new Object::Enum, with one or more sets of possible values.

The simplest case is to pass an arrayref, which returns an object capable of having any one of the given values or of being unset.

The more complex cases involve passing a hashref, which may have the following keys:

• unset

  whether this object can be 'unset' (defaults to true)

• default

  this object's default value is (defaults to undef)

• values

  an arrayref, listing the object's possible values (at least one required)

spawn

clone

  my $new = $obj->clone;

  my $new = $obj->clone($value);

Create a new Enum from an existing object, using the same arguments as were originally passed to "new" when that object was created.

An optional value may be passed in; this is identical to (but more convenient than) calling "value" with the same argument on the newly cloned object.

This method was formerly named "spawn". That name will still work but is deprecated.

value

Note: don't pass in undef; use the unset method instead.

values

unset

is_*

set_*

None of these methods take any arguments.

The "set_*" methods are chainable; that is, they return the object on which they were called. This lets you do useful things like:

  use Object::Enum Enum => { -as => 'color', values => [qw(red blue)] };

  print color->set_red->value; # prints 'red'