NAME

Newcomen::Formatter::Specification - A formatter backend specification.

SYNOPSIS

use Newcomen::Formatter::Specification;

my $spec = Newcomen::Formatter::Specification -> new (
   'name' => $backend_name
);

# Set some option:
$spec -> set (['some', 'option'], 'value');

DESCRIPTION

A formatter backend specification contains a formatter backend name and its options. This is for example used in Newcomen::Content instances to store the formatters that should be used for the content.

CLASS METHODS

new

my $spec = Newcomen::Formatter::Specification -> new (
   'name' => $backend_name
);

Constructor. The name parameter is mandatory, it specifies the formatter backend by its basename (i.e. the module name without the 'Newcomen::Formatter::' prefix). The name can not be changed later on. Newcomen::Formatter::Specification does not check if a backend by the specified name exists.

INSTANCE METHODS

Please see Newcomen::Role::Backend::Specification for a list of instance methods and their description.

VERSION

This is version 2014052501.

AUTHOR

Stefan Goebel - newcomen {at} subtype {dot} de

COPYRIGHT AND LICENSE

This file is part of Newcomen.

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

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

You should have received a copy of the GNU General Public License along with Newcomen. If not, see <http://www.gnu.org/licenses/>.

Newcomen

Index