Object::Pad::FieldAttr::Final - declare Object::Pad fields readonly after construction
Object::Pad::FieldAttr::Final
Object::Pad
use Object::Pad; use Object::Pad::FieldAttr::Final; class Rectangle { field $width :param :reader :Final; field $height :param :reader :Final; field $area :reader :Final; ADJUST { $area = $width * $height; } }
This module provides a third-party field attribute for Object::Pad-based classes, which declares that the field it is attached to shall be set as readonly when the constructor returns, disallowing further modification to it.
WARNING The ability for Object::Pad to take third-party field attributes is still new and highly experimental, and subject to much API change in future. As a result, this module should be considered equally experimental.
field $name :Final ...; field $name :Final ... = DEFAULT;
Declares that the field variable will be set readonly at the end of the constructor, after any assignments from :param declarations or ADJUST blocks. At this point, the value cannot otherwise be modified by directly writing into the field variable.
:param
ADJUST
field $x :Final; ADJUST { $x = 123; } # this is permitted method m { $x = 456; } # this will fail
Note that this is only a shallow readonly setting; if the field variable contains a reference to a data structure, that structure itself remains mutable.
field $aref :Final; ADJUST { $aref = []; } method more { push @$aref, "another"; } # this is permitted
Paul Evans <leonerd@leonerd.org.uk>
To install Object::Pad::FieldAttr::Final, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Object::Pad::FieldAttr::Final
CPAN shell
perl -MCPAN -e shell install Object::Pad::FieldAttr::Final
For more information on module installation, please visit the detailed CPAN module installation guide.