From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

LTHEISEN / Footprintless-1.29 / lib / Footprintless / InvalidEntityException.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
—
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

              
use strict;
use warnings;
package Footprintless::InvalidEntityException;
$Footprintless::InvalidEntityException::VERSION = '1.29';
# ABSTRACT: An exception thrown when an entity is invalid for the context it is being used in
# PODNAME: Footprintless::InvalidEntityException
use Term::ANSIColor;
use overload '""' => 'to_string';
sub new {
    return bless( {}, shift )->_init(@_);
}
sub _init {
    my ( $self, $coordinate, $message ) = @_;
    $self->{coordinate} = $coordinate;
    $self->{message}    = $message;
    $self->{trace}      = [];
    return $self;
}
sub get_coordinate {
    return $_[0]->{coordinate};
}
sub get_message {
    return $_[0]->{message};
}
sub get_trace {
    return $_[0]->{trace};
}
sub PROPAGATE {
    my ( $self, $file, $line ) = @_;
    push( @{ $self->{trace} }, [ $file, $line ] );
}
sub to_string {
    my ( $self, $trace ) = @_;
    my @parts = ("invalid entity at [$self->{coordinate}]: $self->{message}");
    if ( $trace && @{ $self->{trace} } ) {
        push( @parts, "\n****TRACE****" );
        foreach my $stop ( @{ $self->{trace} } ) {
            push( @parts, "$stop->[0]($stop->[1])" );
        }
        push( @parts, "\n****TRACE****" );
    }
    return join( '', @parts );
}
1;
__END__
=pod
=head1 NAME
Footprintless::InvalidEntityException - An exception thrown when an entity is invalid for the context it is being used in
=head1 VERSION
version 1.29
=head1 DESCRIPTION
An exception for when an entity is invalid for the context it is being used in.
=head1 CONSTRUCTORS
=head2 new($message, $coordinate)
Creates a new C<Footprintless::InvalidEntityException> with the 
supplied information.
=head1 ATTRIBUTES
=head2 get_coordinate()
Returns the coordinate.
=head2 get_message()
Returns the message.
=head2 get_trace()
Returns the stack trace when the command runner C<die>d.
=head1 METHODS
=head2 to_string()
Returns a string representation of this exception.
=head1 AUTHOR
Lucas Theisen <lucastheisen@pastdev.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2016 by Lucas Theisen.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 SEE ALSO
Please see those modules/websites for more information related to this module.
=over 4
=item *
L<Footprintless|Footprintless>
=item *
L<Footprintless|Footprintless>
=back
=for Pod::Coverage PROPAGATE
=cut