Trystan Johnson > Farly-0.25 > Farly::Value::String

Download:
Farly-0.25.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.25   Source   Latest Release: Farly-0.26

NAME ^

Farly::Value::String - String value class

SYNOPSIS ^

  use Farly::Value::String;
  
  my $string_1 = Farly::Value::String->new("some string");
  my $string_2 = Farly::Value::String->new("some string");

  print $string_1->as_string();

  $string_1->equals( $string_2 ) ? print "Yes, the objects are equal";

DESCRIPTION ^

Farly::Value::String is a string wrapper class for use as a value object in a Farly::Object.

METHODS ^

new( 'string' )

The constructor.

   my $string = Farly::Value::String->new( "string" );

String to be wrapped must be provided as an argument. Leading and trailing whitespace is stripped.

equals( <Farly::Value::String> )

Returns true if the wrapped strings are 'eq'

  $string_1->equals( $string_2 );

contains( <Farly::Value::String> )

Returns true if the wrapped strings are 'eq'

  $string_1->contains( $string_2 );

intersects( <Farly::Value::String> )

Returns true if the wrapped strings are 'eq'

  $string_1->intersects( $string_2 );

as_string()

Returns the string value

  $string_1->as_string();

COPYRIGHT AND LICENCE ^

Farly::Value::String Copyright (C) 2012 Trystan Johnson

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

syntax highlighting: