propertyconfigurable.java

Java的面向对象数据库系统的源代码

// You can redistribute this software and/or modify it under the terms of
// the Ozone Core License version 1 published by ozone-db.org.
//
// Copyright (C) 2003-@year@, Leo Mekenkamp. All rights reserved.
//
// $Id: PropertyConfigurable.java,v 1.1 2004/01/01 20:29:29 leomekenkamp Exp $

package org.ozoneDB.core.storage;

import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.util.Collection;
import java.util.List;
import java.util.Properties;
import org.ozoneDB.core.ConfigurationException;

/**
 * <p>All classes implementing this interface <i>must</i> provide a public constructor
 * that has one <code>Properties</code> instance, and a <code>String</code> as
 * its only parameters. The string is the prefix this instance should use to
 * get its settings from the properties.</p>
 * <p>Example:<pre>
 * 
 * class Foo {
 *     public Foo(Properties properties, String prefix);
 * // ...
 * }
 *
 * Properties properties;
 * // ...
 * Foo foo = new Foo(properties, "org.ozoneDB.bar");
 * </pre></p>
 * <p>If the <code>Foo</code> class has a property ".directory", then the
 * constructor will call <code>properties.getProperty(prefix + ".directory")</code>.</p>
 *
 * @author <a href="mailto:leoATmekenkampD0Tcom">Leo Mekenkamp (mind the anti sp@m)</a>
 * @version $Id: PropertyConfigurable.java,v 1.1 2004/01/01 20:29:29 leomekenkamp Exp $
 */
public interface PropertyConfigurable {
    
    /**
     * <p>Returns a <code>Collection</code> with all the properties this instance
     * supports.</p>
     *
     * @return Collection with <code>PropertyInfo</code> elements
     */
    public Collection getPropertyInfos();

    public String getPrefix();
}