NAME

HH::Unispool::Config::Entry - Abstract class to group UNISPOOL config entries

SYNOPSIS

None, this is an abstract class.

ABSTRACT

Abstract class for UNISPOOL config file entries

DESCRIPTION

HH::Unispool::Config::Entry is an abstract class to group UNISPOOL config entries. UNISPOOL config file entries are "repeating" elements in UNISPOOL config files such as devices, remote systems and system descriptions. All entries are identified by their 'name'.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new HH::Unispool::Config::Entry 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 may include:

name

Passed to set_name(). Mandatory option.

new_from_tokenizer(TOKENIZER)

This is an interface method. Constructs a new HH::Unispool::Config::Entry object using tokens. TOKENIZER is an HH::Unispool::Config::File::Tokenizer reference. On error an exception Error::Simple is thrown.

METHODS

diff(TO)

Finds differences between two objects. In diff terms, the object is the from object and the specified TO parameter the to object. TO is a reference to an identical object class. Returns an empty string if no difference found and a difference descritpion string otherwise. On error an exception Error::Simple is thrown.

get_name()

Returns the entry name.

set_name(VALUE)

Set the entry name. VALUE is the value. VALUE may not be undef. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.+$

write(FILE_HANDLE)

This is an interface method. Writes the entry to the specified file handle. FILE_HANDLE is an IO::Handle reference. On error an exception Error::Simple is thrown.

SEE ALSO

the HH::Unispool::Config manpage, the HH::Unispool::Config::DateFormat 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::Cs 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