com.google.gwt.core.ext.PropertyOracle Maven / Gradle / Ivy
/*
* Copyright 2008 Google Inc.
*
* 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 com.google.gwt.core.ext;
/**
* Provides deferred binding property values.
*/
public interface PropertyOracle {
/**
* Attempts to get a named configuration property. Throws
* BadPropertyValueException if the property is undefined. The
* result of invoking this method with the same propertyName must
* be stable.
*
* @param propertyName
* @return the configuration property instance (never null)
* @throws BadPropertyValueException if the property is unknown or not a
* configuration property
*/
ConfigurationProperty getConfigurationProperty(String propertyName)
throws BadPropertyValueException;
/**
* Attempts to get a named deferred binding property or configuration
* property. Throws BadPropertyValueException if the property is
* either undefined or has a value that is unsupported. The result of invoking
* this method with the same propertyName must be stable.
*
* @param logger the current logger
* @param propertyName the name of the property
* @return a value for the property
* @throws BadPropertyValueException if the property is unknown or not of the
* right type
*/
@Deprecated
String getPropertyValue(TreeLogger logger, String propertyName)
throws BadPropertyValueException;
/**
* Attempts to get a named deferred binding property and returns the list of
* possible values. Throws BadPropertyValueException if the
* property is a configuration property or is undefined. The result of
* invoking this method with the same propertyName must be
* stable.
*
* @param logger the current logger
* @param propertyName the name of the property
* @return the possible values for the property
* @throws BadPropertyValueException if the property is unknown or not of the
* right type
*/
@Deprecated
String[] getPropertyValueSet(TreeLogger logger, String propertyName)
throws BadPropertyValueException;
/**
* Attempts to get a named deferred binding property. Throws
* BadPropertyValueException if the property is either undefined
* or has a value that is unsupported. The result of invoking this method with
* the same propertyName must be stable.
* @param logger
* @param propertyName
* @return the selection property instance (never null)
* @throws BadPropertyValueException if the property is unknown or not a
* selection property
*/
SelectionProperty getSelectionProperty(TreeLogger logger, String propertyName)
throws BadPropertyValueException;
}