HH::Unispool::Config::File::Token - Abstract class for line string tokens from UNISPOOL config files
Application programmers don't need to use this class and API programmers read code.
Abstract class for UNISPOOL config file tokens
HH::Unispool::Config::File::Token is an abstract class for line string tokens from UNISPOOL config files. It offers a standard implementation of the new_from_string() constructor, interface methods to read/write token information from/to a string read_string() and write_string() and the input_line_number attribute.
HH::Unispool::Config::File::Token
new_from_string()
read_string()
write_string()
input_line_number
By default nothing is exported.
This tag contains printf() formats usefull for writing file tokens.
printf()
Format for B lines.
B
Format for * Device configuration for
* Device configuration for
Format for * Group configuration for lines.
* Group configuration for
Format for * Miscellaneous configuration items for lines.
* Miscellaneous configuration items for
Format for * Remote system configuration for lines.
* Remote system configuration for
Format for C lines.
C
Format for * Configuration server info for lines.
* Configuration server info for
Format for type 0 D lines.
0
D
Format for type 1 D lines.
1
Format for type 2 D lines.
2
Format for type 3 D lines.
3
Format for type 4 D lines.
4
Format for type 5 D lines.
5
Format for type 6 D lines.
6
Format for type 7 D lines.
7
Format for * Dump date lines.
* Dump date
Format for F lines.
F
Format for * Filter file info for lines.
* Filter file info for
Format for G lines.
G
Format for H lines with only 1 field.
H
Format for H lines with 2 fields.
Format for * UNISPOOL <...> configuration dumped on host lines.
* UNISPOOL <...> configuration dumped on host
Format for device I lines.
I
Format for system I lines.
Format for L lines.
L
Format for M lines.
M
Format for N lines with 2 fields.
N
Format for N lines with 3 fields.
Format for N lines with 5 fields.
Format for device N lines.
Format for device P lines.
P
Format for type 3 S lines.
S
Format for type 6 S lines.
Format for type 7 S lines.
Format for type 8 S lines.
8
Format for * Dump scope lines.
* Dump scope
Format for * End of configuration dumped on host lines.
* End of configuration dumped on host
Format for X lines.
X
This tag contains regular expressions usefull for parsing file tokens.
Regular expression to parse B lines.
Regular expression to parse * Device configuration for lines.
Regular expression to parse * Group configuration for lines.
Regular expression to parse * Miscellaneous configuration items for lines.
Regular expression to parse * Remote system configuration for lines.
Regular expression to parse * Configuration server info for lines.
Regular expression to parse C lines.
Regular expression to parse type 0 D lines.
Regular expression to parse type 1 D lines.
Regular expression to parse type 2 D lines.
Regular expression to parse type 3 D lines.
Regular expression to parse type 4 D lines.
Regular expression to parse type 5 D lines.
Regular expression to parse type 6 D lines.
Regular expression to parse type 7 D lines.
Regular expression to parse * Dump date lines.
Regular expression to parse * Filter file info for lines.
Regular expression to parse F lines.
Regular expression to parse G lines.
Regular expression to parse * UNISPOOL <...> configuration dumped on host lines.
Regular expression to parse H lines.
Regular expression to parse device I lines.
Regular expression to parse system I lines.
Regular expression to parse L lines.
Regular expression to parse M lines.
Regular expression to parse N lines.
Regular expression to parse device P lines.
Regular expression to parse type 3 S lines.
Regular expression to parse type 6 S lines.
Regular expression to parse type 7 S lines.
Regular expression to parse type 8 S lines.
Regular expression to parse * Dump scope lines.
Regular expression to parse * End of configuration dumped on host lines.
Regular expression to parse X lines.
Creates a new HH::Unispool::Config::File::Token object. OPT_HASH_REF is a hash reference used to pass initialization options. On error an exception Error::Simple is thrown.
OPT_HASH_REF
Error::Simple
Options for OPT_HASH_REF may include:
Passed to set_input_line_number().
Creates a new object from the specified Unispool config file line string.
Returns the line number from from which the token is read.
This is an interface method. Reads the Unispool config file token from a line string. LINE is a plain line string. On error an exception Error::Simple is thrown.
LINE
Set the line number from from which the token is read. VALUE is the value. On error an exception Error::Simple is thrown.
VALUE
This is an interface method. Returns a Unispool config file token line string.
HH::Unispool::Config, HH::Unispool::Config::DateFormat, HH::Unispool::Config::Entry, HH::Unispool::Config::Entry::Device, HH::Unispool::Config::Entry::Device::0, HH::Unispool::Config::Entry::Device::1, HH::Unispool::Config::Entry::Device::2, HH::Unispool::Config::Entry::Device::3, HH::Unispool::Config::Entry::Device::4, HH::Unispool::Config::Entry::Device::5, HH::Unispool::Config::Entry::Device::6, HH::Unispool::Config::Entry::Device::7, HH::Unispool::Config::Entry::Filter, HH::Unispool::Config::Entry::Numbered, HH::Unispool::Config::Entry::RemoteSystem, HH::Unispool::Config::Entry::RemoteSystem::3, HH::Unispool::Config::Entry::RemoteSystem::6, HH::Unispool::Config::Entry::RemoteSystem::7, HH::Unispool::Config::Entry::RemoteSystem::8, HH::Unispool::Config::Entry::System, HH::Unispool::Config::ExecPri, HH::Unispool::Config::File::Token::Comment, HH::Unispool::Config::File::Token::Comment::Cs, HH::Unispool::Config::File::Token::Comment::Date, HH::Unispool::Config::File::Token::Comment::Device, HH::Unispool::Config::File::Token::Comment::Filter, HH::Unispool::Config::File::Token::Comment::Group, HH::Unispool::Config::File::Token::Comment::Head, HH::Unispool::Config::File::Token::Comment::Misc, HH::Unispool::Config::File::Token::Comment::NetDesc, HH::Unispool::Config::File::Token::Comment::RSys, HH::Unispool::Config::File::Token::Comment::Scope, HH::Unispool::Config::File::Token::Comment::Tail, HH::Unispool::Config::File::Token::Factory, HH::Unispool::Config::File::Token::Numbered, HH::Unispool::Config::File::Token::Numbered::Device, HH::Unispool::Config::File::Token::Numbered::Device::0, HH::Unispool::Config::File::Token::Numbered::Device::1, HH::Unispool::Config::File::Token::Numbered::Device::2, HH::Unispool::Config::File::Token::Numbered::Device::3, HH::Unispool::Config::File::Token::Numbered::Device::4, HH::Unispool::Config::File::Token::Numbered::Device::5, HH::Unispool::Config::File::Token::Numbered::Device::6, HH::Unispool::Config::File::Token::Numbered::Device::7, HH::Unispool::Config::File::Token::Numbered::Device::Group, HH::Unispool::Config::File::Token::Numbered::Device::Info, HH::Unispool::Config::File::Token::Numbered::Device::P, HH::Unispool::Config::File::Token::Numbered::Network, HH::Unispool::Config::File::Token::Numbered::System, HH::Unispool::Config::File::Token::Numbered::System::3, HH::Unispool::Config::File::Token::Numbered::System::6, HH::Unispool::Config::File::Token::Numbered::System::7, HH::Unispool::Config::File::Token::Numbered::System::8, HH::Unispool::Config::File::Token::Numbered::System::Info, HH::Unispool::Config::File::Token::Numbered::X, HH::Unispool::Config::File::Token::Unnumbered, HH::Unispool::Config::File::Token::Unnumbered::Bcs, HH::Unispool::Config::File::Token::Unnumbered::CSN, HH::Unispool::Config::File::Token::Unnumbered::Cs, HH::Unispool::Config::File::Token::Unnumbered::CsBcs, HH::Unispool::Config::File::Token::Unnumbered::Filter, HH::Unispool::Config::File::Token::Unnumbered::Host, HH::Unispool::Config::File::Token::Unnumbered::Misc, HH::Unispool::Config::File::Tokenizer, HH::Unispool::Config::FilterType, HH::Unispool::Config::OS, HH::Unispool::Config::Scope
None known (yet.)
First development: January 2003 Last update: September 2003
Vincenzo Zocca
Copyright 2003 by Vincenzo Zocca
This file is part of the HH::Unispool::Config module hierarchy for Perl by Vincenzo Zocca.
HH::Unispool::Config
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
To install HH::Unispool::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm HH::Unispool::Config
CPAN shell
perl -MCPAN -e shell install HH::Unispool::Config
For more information on module installation, please visit the detailed CPAN module installation guide.