NAME

HH::Unispool::Config::File::Token::Comment::Cs - configuration server comment token

SYNOPSIS

Application programmers don't need to use this class and API programmers read code.

ABSTRACT

configuration server comment token

DESCRIPTION

HH::Unispool::Config::File::Token::Comment::Cs contains information on the configuration server comment token.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new HH::Unispool::Config::File::Token::Comment::Cs 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::Comment::NetDesc may include:

net_desc

Passed to set_net_desc(). Mandatory option.

new_from_string(LINE)

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

METHODS

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.

get_net_desc()

This method is inherited from package HH::Unispool::Config::File::Token::Comment::NetDesc. Returns the network descriptor name in the comment.

read_string(LINE)

This method is overloaded from package HH::Unispool::Config::File::Token::Comment. 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_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*$

set_net_desc(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Comment::NetDesc. Set the network descriptor 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:

^.+$

write_string()

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

SEE ALSO

the HH::Unispool::Config manpage, the HH::Unispool::Config::DateFormat manpage, the HH::Unispool::Config::Entry manpage, the HH::Unispool::Config::Entry::Device manpage, the HH::Unispool::Config::Entry::Device::0 manpage, the HH::Unispool::Config::Entry::Device::1 manpage, the HH::Unispool::Config::Entry::Device::2 manpage, the HH::Unispool::Config::Entry::Device::3 manpage, the HH::Unispool::Config::Entry::Device::4 manpage, the HH::Unispool::Config::Entry::Device::5 manpage, the HH::Unispool::Config::Entry::Device::6 manpage, the HH::Unispool::Config::Entry::Device::7 manpage, the HH::Unispool::Config::Entry::Filter manpage, the HH::Unispool::Config::Entry::Numbered manpage, the HH::Unispool::Config::Entry::RemoteSystem manpage, the HH::Unispool::Config::Entry::RemoteSystem::3 manpage, the HH::Unispool::Config::Entry::RemoteSystem::6 manpage, the HH::Unispool::Config::Entry::RemoteSystem::7 manpage, the HH::Unispool::Config::Entry::RemoteSystem::8 manpage, the HH::Unispool::Config::Entry::System manpage, the HH::Unispool::Config::ExecPri manpage, the HH::Unispool::Config::File::Token manpage, the HH::Unispool::Config::File::Token::Comment manpage, the HH::Unispool::Config::File::Token::Comment::Date manpage, the HH::Unispool::Config::File::Token::Comment::Device manpage, the HH::Unispool::Config::File::Token::Comment::Filter manpage, the HH::Unispool::Config::File::Token::Comment::Group manpage, the HH::Unispool::Config::File::Token::Comment::Head manpage, the HH::Unispool::Config::File::Token::Comment::Misc manpage, the HH::Unispool::Config::File::Token::Comment::NetDesc manpage, the HH::Unispool::Config::File::Token::Comment::RSys manpage, the HH::Unispool::Config::File::Token::Comment::Scope manpage, the HH::Unispool::Config::File::Token::Comment::Tail manpage, the HH::Unispool::Config::File::Token::Factory manpage, the HH::Unispool::Config::File::Token::Numbered manpage, the HH::Unispool::Config::File::Token::Numbered::Device manpage, the HH::Unispool::Config::File::Token::Numbered::Device::0 manpage, the HH::Unispool::Config::File::Token::Numbered::Device::1 manpage, the HH::Unispool::Config::File::Token::Numbered::Device::2 manpage, the HH::Unispool::Config::File::Token::Numbered::Device::3 manpage, the HH::Unispool::Config::File::Token::Numbered::Device::4 manpage, the HH::Unispool::Config::File::Token::Numbered::Device::5 manpage, the HH::Unispool::Config::File::Token::Numbered::Device::6 manpage, the HH::Unispool::Config::File::Token::Numbered::Device::7 manpage, the HH::Unispool::Config::File::Token::Numbered::Device::Group manpage, the HH::Unispool::Config::File::Token::Numbered::Device::Info manpage, the HH::Unispool::Config::File::Token::Numbered::Device::P manpage, the HH::Unispool::Config::File::Token::Numbered::Network manpage, the HH::Unispool::Config::File::Token::Numbered::System manpage, the HH::Unispool::Config::File::Token::Numbered::System::3 manpage, the HH::Unispool::Config::File::Token::Numbered::System::6 manpage, the HH::Unispool::Config::File::Token::Numbered::System::7 manpage, the HH::Unispool::Config::File::Token::Numbered::System::8 manpage, the HH::Unispool::Config::File::Token::Numbered::System::Info manpage, the HH::Unispool::Config::File::Token::Numbered::X manpage, the HH::Unispool::Config::File::Token::Unnumbered manpage, the HH::Unispool::Config::File::Token::Unnumbered::Bcs manpage, the HH::Unispool::Config::File::Token::Unnumbered::CSN manpage, the HH::Unispool::Config::File::Token::Unnumbered::Cs manpage, the HH::Unispool::Config::File::Token::Unnumbered::CsBcs manpage, the HH::Unispool::Config::File::Token::Unnumbered::Filter manpage, the HH::Unispool::Config::File::Token::Unnumbered::Host manpage, the HH::Unispool::Config::File::Token::Unnumbered::Misc manpage, the HH::Unispool::Config::File::Tokenizer manpage, the HH::Unispool::Config::FilterType manpage, the HH::Unispool::Config::OS manpage, the HH::Unispool::Config::Scope manpage

BUGS

None known (yet.)

HISTORY

First development: February 2003 Last update: September 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2003 by Vincenzo Zocca

LICENSE

This file is part of the HH::Unispool::Config module hierarchy for Perl by Vincenzo Zocca.

The HH::Unispool::Config module hierarchy 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 2 of the License, or (at your option) any later version.

The HH::Unispool::Config module hierarchy 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 the HH::Unispool::Config module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA