/**
 * Copyright (C) 2015 Valkyrie RCP
 *
 * 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.valkyriercp.binding;

import java.util.Map;

/**
 * Simple interface for accessing metadata about a particular property.
 *
 * @author Keith Donald
 */
public interface PropertyMetadataAccessStrategy {

	/**
	 * Determine if the given property is readable.
	 *
	 * @param propertyName property to examine.
	 * @return <code>true</code> if the property is readable.
	 */
	boolean isReadable(String propertyName);

	/**
	 * Determine if the given property is writeable.
	 *
	 * @param propertyName property to examine.
	 * @return <code>true</code> if the property is writeable.
	 */
	boolean isWriteable(String propertyName);

	/**
	 * Get the type of the given property.
	 *
	 * @param propertyName property to examine.
	 * @return the type of the property.
	 */
	Class getPropertyType(String propertyName);

	/**
	 * Returns custom metadata that may be associated with the specified
	 * property path.
	 *
	 * @param propertyName property to examine.
	 * @param key used to retreive the metadata.
	 * @return Object stored under the given key.
	 */
	Object getUserMetadata(String propertyName, String key);

	/**
	 * Returns all custom metadata associated with the specified property in the
	 * form of a Map.
	 *
	 * @param propertyName property to examine.
	 * @return Map containing String keys - this method may or may not return
	 * <code>null</code> if there is no custom metadata associated with the
	 * property.
	 */
	Map getAllUserMetadata(String propertyName);
}