PropertyGetter.java

/*
 * -----------------------------------------------------------------------\
 * PerfCake
 *  
 * Copyright (C) 2010 - 2016 the original author or authors.
 *  
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * -----------------------------------------------------------------------/
 */
package org.perfcake.util.properties;

/**
 * Provides properties.
 *
 * @author <a href="mailto:marvenec@gmail.com">Martin Večeřa</a>
 */
public interface PropertyGetter {

   /**
    * Gets a property with a given name. If the property is not found, returns the <code>defaultValue</code>.
    *
    * @param propName
    *       Property name.
    * @param defaultValue
    *       The default value.
    * @return Property value or the <code>defaultValue</code>, if property is not found.
    */
   public String getProperty(String propName, String defaultValue);

   /**
    * Gets a property with a given name or a <code>null</code> value, if the property is not found.
    *
    * @param propName
    *       Property name.
    * @return Property value or a <code>null</code>, if property is not found.
    */
   public String getProperty(String propName);
}