/ 
Class-Enumeration-v1.2.0
/ Class::Enumeration

NAME

Class::Enumeration - Abstract parent class of enum classes

SYNOPSIS

use strict;
use warnings;

package TurnstileState;

use parent 'Class::Enumeration';

# Define list of enum objects
my @values;
sub values { no critic ( ProhibitBuiltinHomonyms )
  my $ordinal = 0;
  @values = map { __PACKAGE__->_new( $ordinal++, $_ ) } qw( Locked Unlocked )
    unless @values;
  @values
}

1

CAVEAT

This class is abstract. It defines and partially implements the API of enum classes. It should not be used directly. You should use the Class::Enumeration::Builder module instead.

DESCRIPTION

An enum class is a list of enum objects. Each enum object is immutable and has a name and an ordinal attribute.

Each enum class has a name() getter method (an object method), that returns the name of the enum object, exactly as defined.

Each enum class has an ordinal() getter method (an object method), that returns the ordinal number of the enum object. It defaults to the position in its definition, where the initial object is assigned an ordinal number of zero.

Each enum class has a names() class method, that returns the list of names of the enum objects in the order they were defined.

Each enum class has a values() class method, that returns the list of the enum objects sorted according to their ordinal number (lowest to highest). This method is abstract and gets implemented by the Class::Enumeration::Builder module.

Each enum class has a value_of( $name ) factory method (a class method), that returns the enum object with the specified name.

Each enum class inherits stringification '""' from its Class::Enumeration parent class. By default the string representation of an enum object returns its name. If you want to override this behaviour, you have to provide an to_string() implementation in your enum class.

The parent class Class::Enumeration overloads the operators '==', and '!=' too. Magic auto-generation of overload implementations for other operators is turned off. An enum class can add its own overload implementations.

SEE ALSO

AUTHOR

Sven Willenbuecher <sven.willenbuecher@gmx.de>

COPYRIGHT AND LICENSE

This software is copyright (c) 2025 by Sven Willenbuecher.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.