1  /*
     2   * Copyright the original author or authors.
     3   * 
     4   * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   * 
     8   *      http://www.mozilla.org/MPL/MPL-1.1.html
     9   * 
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16   
    17  import org.as2lib.core.BasicInterface;
    18  
    19  /**
    20   * {@code Properties} represents a persistent set of properties; simply key-value
    21   * pairs.
    22   * 
    23   * @author Martin Heidegger
    24   * @author Simon Wacker
    25   * @version 1.0
    26   */
    27  interface org.as2lib.data.holder.Properties extends BasicInterface {
    28  	
    29  	/**
    30  	 * Returns the value associated with the given {@code key} if there is one, and the
    31  	 * given {@code defaultValue} otherwise.
    32  	 * 
    33  	 * @param key the key to return the value for
    34  	 * @param defaultValue the default value to return if there is no value mapped to the
    35  	 * given {@code key}
    36  	 * @return the value mapped to the given {@code key} or the given {@code defaultValue}
    37  	 */
    38  	public function getProperty(key:String, defaultValue:String):String;
    39  	
    40  	/**
    41  	 * Sets the given {@code value} for the given {@code key}; the {@code value} is mapped
    42  	 * to the {@code key}.
    43  	 * 
    44  	 * @param key the key to map the {@code value} to
    45  	 * @param value the value to map to the {@code key}
    46  	 */
    47  	public function setProperty(key:String, value:String):Void;
    48  	
    49  }
as2api