PropertyDao.java

/*
 * Copyright 2010 FatWire Corporation. All Rights Reserved.
 *
 * 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 tools.gsf.properties;

import java.util.Collection;

/**
 * Utility to retrieve properties
 *
 * @author Tony Field
 * @since 2011-09-02
 */
public interface PropertyDao {
    Property getProperty(String name);

    Collection<String> getPropertyNames();

    /**
     * Set (or re-set) a property value
     * @param property property object with name and value
     */
    void setProperty(Property property);

    /**
     * Convenience method to set (or re-set) a property value
     * @param name property name
     * @param description description of property
     * @param propertyValue value as a string
     */
    void setProperty(String name, String description, String propertyValue);

    /**
     * Add the property specified to the sites specified. The property is NOT
     * un-shared from any other sites using this tag (it only adds additional sites)
     * @param name property name
     * @param sitename site names to add the property to
     */
    void addToSite(String name, String... sitename);
}