HH::Unispool::Config::File::Token::Numbered::Device::Group - group device I<G> token

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

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

# Used by _value_is_allowed
our %ALLOW_ISA = (
);

# Used by _value_is_allowed
our %ALLOW_REF = (
);

# Used by _value_is_allowed
our %ALLOW_RX = (
    'member_device_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::Group::_initialize, first argument must be 'HASH' reference.");

    # member_device_name, MULTI
    if ( exists( $opt->{member_device_name} ) ) {
        ref( $opt->{member_device_name} ) eq 'ARRAY' || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::Group::_initialize, specified value for option 'member_device_name' must be an 'ARRAY' reference.");
        $self->set_member_device_name( @{ $opt->{member_device_name} } );
    }
    else {
        $self->set_member_device_name();
    }

    # 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 ( defined($val) && ! 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 add_member_device_name {
    my $self = shift;

    # Check if isas/refs/rxs/values are allowed
    &_value_is_allowed( 'member_device_name', @_ ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::Group::add_member_device_name, one or more specified value(s) '@_' is/are not allowed.");

    # Add values
    foreach my $val (@_) {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device_Group}{member_device_name}{$val} = $val;
    }
}

sub delete_member_device_name {
    my $self = shift;

    # Delete values
    my $del = 0;
    foreach my $val (@_) {
        exists( $self->{HH_Unispool_Config_File_Token_Numbered_Device_Group}{member_device_name}{$val} ) || next;
        delete( $self->{HH_Unispool_Config_File_Token_Numbered_Device_Group}{member_device_name}{$val} );
        $del ++;
    }
    return($del);
}

sub exists_member_device_name {
    my $self = shift;

    # Count occurrences
    my $count = 0;
    foreach my $val (@_) {
        $count += exists( $self->{HH_Unispool_Config_File_Token_Numbered_Device_Group}{member_device_name}{$val} );
    }
    return($count);
}

sub read_string {
    my $self = shift;
    my $line = shift;

    # Parse line for name
    my ($number, $tail) = $line =~ /$USP_G_RX/;
    defined($number) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::Group::read_string, parameter 'LINE' does not match the regular expression for this token's line string.");
    my @member = $self->_split_tail($tail);

    # Set attributes
    $self->set_number($number);
    $self->set_member_device_name();
    ($member[0]) && $self->add_member_device_name($member[0]);
    ($member[1]) && $self->add_member_device_name($member[1]);
    ($member[2]) && $self->add_member_device_name($member[2]);
    ($member[3]) && $self->add_member_device_name($member[3]);
}

sub set_member_device_name {
    my $self = shift;

    # Check if isas/refs/rxs/values are allowed
    &_value_is_allowed( 'member_device_name', @_ ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::Group::set_member_device_name, one or more specified value(s) '@_' is/are not allowed.");

    # Empty list
    $self->{HH_Unispool_Config_File_Token_Numbered_Device_Group}{member_device_name} = {};

    # Add values
    foreach my $val (@_) {
        $self->{HH_Unispool_Config_File_Token_Numbered_Device_Group}{member_device_name}{$val} = $val;
    }
}

sub values_member_device_name {
    my $self = shift;

    # Return all values
    return( values( %{ $self->{HH_Unispool_Config_File_Token_Numbered_Device_Group}{member_device_name} } ) );
}

sub write_string {
    my $self = shift;

    # Make string and return it
    my @member = sort( $self->values_member_device_name() );
    return(
        sprintf(
            $USP_G_FRM,
            $self->get_number() || 0,
            $member[0] || '',
            $member[1] || '',
            $member[2] || '',
            $member[3] || '',
        )
    );
}