HH::Unispool::Config::File::Token::Unnumbered::Bcs 0.3

HH::Unispool::Config::File::Token::Unnumbered::Bcs is a Perl class for BCS B tokens.

SYNOPSIS

Application programmers dont need to use this class and API programmers read code.

ABSTRACT

class for BCS B tokens

HH::Unispool::Config::File::Token::Unnumbered::Bcs is a class for BCS B tokens.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new HH::Unispool::Config::File::Token::Unnumbered::Bcs object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::File::Token may include:

input_line_number

Passed to set_input_line_number().

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::File::Token::Unnumbered::CsBcs may include:

hostname

Passed to set_hostname(). Mandatory option.

new_from_string(LINE)

Creates a new object from the specified Unispool config file line string.

METHODS

get_hostname()

This method is inherited from package HH::Unispool::Config::File::Token::Unnumbered::CsBcs. Returns the host name in the comment.

get_input_line_number()

This method is inherited from package HH::Unispool::Config::File::Token. Returns the line number from from which the token is read.

read_string(LINE)

This method is overloaded from package HH::Unispool::Config::File::Token::Unnumbered. Reads the Unispool config file token from a line string. LINE is a plain line string. On error an exception Error::Simple is thrown.

set_hostname(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Unnumbered::CsBcs. Set the host name in the comment. VALUE is the value. VALUE may not be undef. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.+$

set_input_line_number(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token. Set the line number from from which the token is read. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^d*$

write_string()

This method is overloaded from package HH::Unispool::Config::File::Token::Unnumbered. Returns a Unispool config file token line string.