The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

FANGLY / Bio-Community-0.001008 / lib / Bio / Community / Role / Locked.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

              
# BioPerl module for Bio::Community::Role::Locked
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Copyright 2011-2014 Florent Angly <florent.angly@gmail.com>
#
# You may distribute this module under the same terms as perl itself
=head1 NAME
Bio::Community::Role::Locked - Role for objects that can be locked (made read-only)
=head1 SYNOPSIS
  package My::Package;
  use Moose;
  with 'Bio::Community::Role::Locked';
  # Use the lock() and unlock() methods as needed
  # ...
  1;
=head1 DESCRIPTION
This role provides the capability to make objects of the class that consumes this
role read-only. The lock() method can be invoked to make an object read-only,
while unlock() restores the read/write properties of the object. If you try to
call a method to modify an object that is locked or otherwise attempt to change
its hash, you will get an error similar to this:
 Modification of a read-only value attempted at accessor Bio::Community::Member::foo
=head1 AUTHOR
Florent Angly L<florent.angly@gmail.com>
=head1 SUPPORT AND BUGS
User feedback is an integral part of the evolution of this and other Bioperl
modules. Please direct usage questions or support issues to the mailing list, 
L<bioperl-l@bioperl.org>, rather than to the module maintainer directly. Many
experienced and reponsive experts will be able look at the problem and quickly 
address it. Please include a thorough description of the problem with code and
data examples if at all possible.
If you have found a bug, please report it on the BioPerl bug tracking system
to help us keep track the bugs and their resolution:
L<https://redmine.open-bio.org/projects/bioperl/>
=head1 COPYRIGHT
Copyright 2011-2014 by Florent Angly <florent.angly@gmail.com>
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.10.1 or,
at your option, any later version of Perl 5 you may have available.
=head1 APPENDIX
The rest of the documentation details each of the object
methods. Internal methods are usually preceded with a _
=cut
package Bio::Community::Role::Locked;
use Moose::Role;
use Method::Signatures;
use namespace::autoclean;
use Hash::Util ();
=head2 lock
 Usage   : $member->lock();
 Function: Lock the object, making it read-only.
 Args    : None
 Returns : 1 for success
=cut
method lock () {
   #Hash::Util::lock_hash_recurse(%$self);
   Hash::Util::lock_hash(%$self);
   return 1;
}
=head2 unlock
 Usage   : $member->unlock();
 Function: Unlock the object, restoring its read and write properties.
 Args    : None
 Returns : 1 for success
=cut
method unlock () {
   #Hash::Util::unlock_hash_recurse(%$self);
   Hash::Util::unlock_hash(%$self);
   return 1;
}
1;