Ant4EclipseConfiguration.java

/**********************************************************************
 * Copyright (c) 2005-2009 ant4eclipse project team.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Nils Hartmann, Daniel Kasmeroglu, Gerd Wuetherich
 **********************************************************************/
package org.ant4eclipse.lib.core.configuration;

import org.ant4eclipse.lib.core.util.Pair;

/**
 * <p>
 * Defines the interface to access the configuration of ant4eclipse.
 * </p>
 * 
 * @author Nils Hartmann (nils@nilshartmann.net)
 */
public interface Ant4EclipseConfiguration {

  /**
   * <p>
   * Returns the property with the given name or <code>null</code> if there is no such property.
   * </p>
   * 
   * @param propertyName
   *          The name of the property
   * @return The property or <code>null</code> if there is no such property
   */
  String getProperty(String propertyName);

  /**
   * <p>
   * Checks if there is a property with the given name.
   * </p>
   * 
   * @param propertyName
   *          The name of the property to check
   * @return <code>true</code> if there is a property with the given name otherwise <code>false</code>
   */
  boolean hasProperty(String propertyName);

  /**
   * <p>
   * Returns an {@link Iterable} that contains all properties whose names start with the specified prefix.
   * </p>
   * <p>
   * The returned Iterable contains a String-array with two items: the first is the property key (with prefix removed!)
   * the second is the property value.
   * </p>
   * 
   * @param prefix
   *          The prefix that selected the properties. If it doesn't end with a "." a "." is added
   * @return see above
   */
  Iterable<Pair<String, String>> getAllProperties(String prefix);

} /* ENDINTERFACE */