File Coverage

blib/lib/SWIFT/Factory/Tag/Tag21.pm

Criterion	Covered	Total	%
statement	14	34	41.1
branch	0	14	0.0
condition	0	3	0.0
subroutine	5	12	41.6
pod	5	5	100.0
total	24	68	35.2

package SWIFT::Factory::Tag::Tag21;
use strict;
use warnings;

###########################################################################################################
# Provide a SWIFT TAG 21.
#
# Use this class to provide a Related Reference.
#
###########################################################################################################

BEGIN{
   *provide=*string;
   *borken=*invalid;
}

use vars qw($VERSION);
$VERSION='0.01';

use constant REF_MAX_LEN=>16;

###########################################################################################################
sub new {
   my$self={};
   bless($self,shift())->_init(@_);
}

###########################################################################################################
# The class cannot guarantee that the TAG will be valid in the SWIFT network.
# It can point out that it's found some invalid data, though.
# Return number of problems detected.
sub invalid {
   my$self=shift;

   # Implement verifications here!
   0;
}

###########################################################################################################
sub ref_max_len {
   REF_MAX_LEN;
}

###########################################################################################################
# If a new Reference is provided, store it for future use.
# If requested, return the stored Reference to the caller.
sub reference {
   my($self,$reference)=@_;
   defined($reference)&&$self->_store_reference($reference);
   return(defined(wantarray)?wantarray?($self->{REFERENCE}):$self->{REFERENCE}:undef);
}

###########################################################################################################
sub string {
   my$self=shift;
   ':21:'.
   $self->{REFERENCE}.
   chr(13). # CR
   chr(10); # LF
}

###########################################################################################################
###########################################################################################################
#
# 'Internal' subs. Don't call these since they may, and will, change without notice.
#
###########################################################################################################
###########################################################################################################

###########################################################################################################
sub _init {
   my$self=shift();
   my%args=(
      DO_CLEANUP=>0,
      REFERENCE=>'',
      @_);

   $self->{DO_CLEANUP}=defined($args{DO_CLEANUP})?$args{DO_CLEANUP}?1:0:0;
   $self->_store_reference($args{REFERENCE});
   $self;
}

###########################################################################################################
# If Reference is defined, store it together with some simple cleanup applied.
sub _store_reference {
   my($self,$reference)=@_;

   defined($reference)||return;

   $self->{DO_CLEANUP}&&length($reference)>REF_MAX_LEN&&do{
      # Apply conditional warnings here!
      $reference=substr($reference,0,REF_MAX_LEN);
   };

   $self->{REFERENCE}=$reference;
}

###########################################################################################################
'Choppers rule';
__END__