//==================================================================================================
// D a t a _ s t r u c t u r e                                                                 Java
// E x t e n s i o n
// S t r i n g P r o p e r t y
//                                                                                By Bruno Bachelet
//==================================================================================================
// Copyright (c) 1999-2016
// Bruno Bachelet - bruno@nawouak.net - http://www.nawouak.net
//
// This file is part of the B++ Library. This library is free software; you can redistribute it
// and/or modify it under the terms of the GNU Library General Public License as published by the
// Free Software Foundation; either version 2 of the License, or (at your option) any later
// version.
//
// This library 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 Library General Public License for more details (http://www.gnu.org).

/*DESCRIPTION*/
/* This module provides a class to model a string additional property for extendable objects. */

// Package //---------------------------------------------------------------------------------------
package bpp.data_structure.extension;

// Importation //-----------------------------------------------------------------------------------

// S t r i n g P r o p e r t y  Class //------------------------------------------------------------
/*CLASS StringProperty */
/* Represents a string additional property for extendable objects. It wraps a value of the
   class <CODE>String</CODE> in an object. */
public class StringProperty implements Property {
 //---------------------------------------------------------------------------------------Attributes
 protected String atValue;
 //--------------------------------------------------------------------------------------Constructor
 /*METHOD StringProperty */ /* Builds a property with default value. */
 public StringProperty() { atValue=""; }
 //--------------------------------------------------------------------------------------Constructor
 /*METHOD StringProperty */ /* Builds a property from a <CODE>String</CODE> value. */
 public StringProperty(String agValue) { atValue=agValue; }
 //----------------------------------------------------------------------------------------Duplicate
 /*METHOD StringProperty */ /* Duplicates the property. */
 public Property duplicate() { return (new StringProperty(atValue)); }
 //-----------------------------------------------------------------------------------------ToString
 /*METHOD StringProperty */ /* Returns a string that fully describes the state of the property. */
 public String toString() { return (atValue); }
 //---------------------------------------------------------------------------------------FromString
 /*METHOD StringProperty */
 /* Changes the state of the property according to the description provided by a given string. */
 public void fromString(String agString) { atValue=agString.trim(); }
}

// End //-------------------------------------------------------------------------------------------