HH::Unispool::Config::File::Token::Numbered::Device - abstract class for device I<D> tokens

package HH::Unispool::Config::File::Token::Numbered::Device;

use 5.006;
use base qw( HH::Unispool::Config::File::Token::Numbered );
use strict;
use warnings;
use AutoLoader qw(AUTOLOAD);
use Error qw(:try);

# Used by _value_is_allowed
our %ALLOW_ISA = (
    'execution_priority' => [ 'HH::Unispool::Config::ExecPri' ],
);

# Used by _value_is_allowed
our %ALLOW_REF = (
);

# Used by _value_is_allowed
our %ALLOW_RX = (
    'block_delay' => [ '^\d*$' ],
    'buffer_size' => [ '^\d*$' ],
    'connect_retry' => [ '^\d*$' ],
    'device_name' => [ '^.+$' ],
    'device_password' => [ '^.*$' ],
    'page_length' => [ '^\d*$' ],
    'page_width' => [ '^\d*$' ],
    'remote_device_name' => [ '^.*$' ],
    'remote_system_name' => [ '^.*$' ],
);

# Used by _value_is_allowed
our %ALLOW_VALUE = (
);

# Package version
our ($VERSION) = '$Revision: 0.3 $' =~ /\$Revision:\s+([^\s]+)/;

1;

__END__

sub _initialize {
    my $self = shift;
    my $opt = defined($_[0]) ? shift : {};

    # Check $opt
    ref($opt) eq 'HASH' || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::_initialize, first argument must be 'HASH' reference.");

    # block_delay, SINGLE
    exists( $opt->{block_delay} ) && $self->set_block_delay( $opt->{block_delay} );

    # buffer_size, SINGLE
    exists( $opt->{buffer_size} ) && $self->set_buffer_size( $opt->{buffer_size} );

    # connect_retry, SINGLE
    exists( $opt->{connect_retry} ) && $self->set_connect_retry( $opt->{connect_retry} );

    # device_name, SINGLE, mandatory
    exists( $opt->{device_name} ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::_initialize, option 'device_name' is mandatory.");
    $self->set_device_name( $opt->{device_name} );

    # device_password, SINGLE
    exists( $opt->{device_password} ) && $self->set_device_password( $opt->{device_password} );

    # execution_priority, SINGLE
    exists( $opt->{execution_priority} ) && $self->set_execution_priority( $opt->{execution_priority} );

    # initially_spooled, BOOLEAN
    exists( $opt->{initially_spooled} ) && $self->set_initially_spooled( $opt->{initially_spooled} );

    # networkwide, BOOLEAN
    exists( $opt->{networkwide} ) && $self->set_networkwide( $opt->{networkwide} );

    # page_length, SINGLE
    exists( $opt->{page_length} ) && $self->set_page_length( $opt->{page_length} );

    # page_width, SINGLE
    exists( $opt->{page_width} ) && $self->set_page_width( $opt->{page_width} );

    # remote_device_name, SINGLE
    exists( $opt->{remote_device_name} ) && $self->set_remote_device_name( $opt->{remote_device_name} );

    # remote_system_name, SINGLE
    exists( $opt->{remote_system_name} ) && $self->set_remote_system_name( $opt->{remote_system_name} );

    # save_printfile, BOOLEAN
    exists( $opt->{save_printfile} ) && $self->set_save_printfile( $opt->{save_printfile} );

    # unispool_control, BOOLEAN
    exists( $opt->{unispool_control} ) && $self->set_unispool_control( $opt->{unispool_control} );

    # unispool_header, BOOLEAN
    exists( $opt->{unispool_header} ) && $self->set_unispool_header( $opt->{unispool_header} );

    # Call the superclass' _initialize
    $self->SUPER::_initialize($opt);

    # Return $self
    return($self);
}

sub _value_is_allowed {
    my $name = shift;

    # Value is allowed if no ALLOW clauses exist for the named attribute
    if ( ! exists( $ALLOW_ISA{$name} ) && ! exists( $ALLOW_REF{$name} ) && ! exists( $ALLOW_RX{$name} ) && ! exists( $ALLOW_VALUE{$name} ) ) {
        return(1);
    }

    # At this point, all values in @_ must to be allowed
    CHECK_VALUES:
    foreach my $val (@_) {
        # Check ALLOW_ISA
        if ( ref($val) && exists( $ALLOW_ISA{$name} ) ) {
            foreach my $class ( @{ $ALLOW_ISA{$name} } ) {
                &UNIVERSAL::isa( $val, $class ) && next CHECK_VALUES;
            }
        }

        # Check ALLOW_REF
        if ( ref($val) && exists( $ALLOW_REF{$name} ) ) {
            exists( $ALLOW_REF{$name}{ ref($val) } ) && next CHECK_VALUES;
        }

        # Check ALLOW_RX
        if ( ! ref($val) && exists( $ALLOW_RX{$name} ) ) {
            foreach my $rx ( @{ $ALLOW_RX{$name} } ) {
                $val =~ /$rx/ && next CHECK_VALUES;
            }
        }

        # Check ALLOW_VALUE
        if ( ! ref($val) && exists( $ALLOW_VALUE{$name} ) ) {
            exists( $ALLOW_VALUE{$name}{$val} ) && next CHECK_VALUES;
        }

        # We caught a not allowed value
        return(0);
    }

    # OK, all values are allowed
    return(1);
}

sub get_block_delay {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{block_delay} );
}

sub get_buffer_size {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{buffer_size} );
}

sub get_connect_retry {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{connect_retry} );
}

sub get_device_name {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{device_name} );
}

sub get_device_password {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{device_password} );
}

sub get_execution_priority {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{execution_priority} );
}

sub get_page_length {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{page_length} );
}

sub get_page_width {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{page_width} );
}

sub get_remote_device_name {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{remote_device_name} );
}

sub get_remote_system_name {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{remote_system_name} );
}

sub is_initially_spooled {
    my $self = shift;

    if ( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{initially_spooled} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_networkwide {
    my $self = shift;

    if ( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{networkwide} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_save_printfile {
    my $self = shift;

    if ( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{save_printfile} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_unispool_control {
    my $self = shift;

    if ( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_control} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_unispool_header {
    my $self = shift;

    if ( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_header} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub read_string {
    my $self = shift;

    $self->SUPER::read_string(@_);
}

sub set_block_delay {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'block_delay', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_block_delay, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Device}{block_delay} = $val;
}

sub set_buffer_size {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'buffer_size', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_buffer_size, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Device}{buffer_size} = $val;
}

sub set_connect_retry {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'connect_retry', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_connect_retry, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Device}{connect_retry} = $val;
}

sub set_device_name {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'device_name', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_device_name, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Device}{device_name} = $val;
}

sub set_device_password {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'device_password', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_device_password, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Device}{device_password} = $val;
}

sub set_execution_priority {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'execution_priority', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_execution_priority, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Device}{execution_priority} = $val;
}

sub set_initially_spooled {
    my $self = shift;

    if (shift) {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device}{initially_spooled} = 1;
    }
    else {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device}{initially_spooled} = 0;
    }
}

sub set_networkwide {
    my $self = shift;

    if (shift) {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device}{networkwide} = 1;
    }
    else {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device}{networkwide} = 0;
    }
}

sub set_page_length {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'page_length', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_page_length, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Device}{page_length} = $val;
}

sub set_page_width {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'page_width', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_page_width, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Device}{page_width} = $val;
}

sub set_remote_device_name {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'remote_device_name', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_remote_device_name, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Device}{remote_device_name} = $val;
}

sub set_remote_system_name {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'remote_system_name', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_remote_system_name, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Device}{remote_system_name} = $val;
}

sub set_save_printfile {
    my $self = shift;

    if (shift) {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device}{save_printfile} = 1;
    }
    else {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device}{save_printfile} = 0;
    }
}

sub set_unispool_control {
    my $self = shift;

    if (shift) {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_control} = 1;
    }
    else {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_control} = 0;
    }
}

sub set_unispool_header {
    my $self = shift;

    if (shift) {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_header} = 1;
    }
    else {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_header} = 0;
    }
}

sub write_string {
    my $self = shift;

    $self->SUPER::read_string(@_);
}