org.joda.beans.MetaProperty Maven / Gradle / Ivy
/*
* Copyright 2001-2014 Stephen Colebourne
*
* 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.joda.beans;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.List;
import java.util.NoSuchElementException;
import org.joda.convert.StringConvert;
/**
* A meta-property, defining those aspects of a property which are not specific
* to a particular bean, such as the property type and name.
*
* @param the type of the property content
* @author Stephen Colebourne
*/
public interface MetaProperty
extends BeanQuery
{
/**
* Creates a property that binds this meta-property to a specific bean.
*
* This method returns a {@code Property} instance that connects this meta-property to the specified bean.
* The result can be queried and passed around without further reference to the bean.
*
* @param bean the bean to create the property for, not null
* @return the property, not null
*/
Property
createProperty(Bean bean);
//-----------------------------------------------------------------------
/**
* Gets the meta-bean which owns this meta-property.
*
* Each meta-property is fully owned by a single bean.
*
* @return the meta-bean, not null
*/
MetaBean metaBean();
/**
* Gets the property name.
*
* The JavaBean style methods getFoo() and setFoo() will lead to a property
* name of 'foo' and so on.
*
* @return the name of the property, not empty
*/
String name();
/**
* Get the type that declares the property, represented as a {@code Class}.
*
* This is the type of the bean where the property is declared.
*
* @return the type declaring the property, not null
*/
Class declaringType();
/**
* Get the type of the property represented as a {@code Class}.
*
* This is the type of the property.
* For example, the surname of a person would typically be a {@code String}.
*
* @return the type of the property, not null
*/
Class
propertyType();
/**
* Gets the generic types of the property.
*
* This provides access to the generic type declared in the source code.
*
* @return the full generic type of the property, unmodifiable, not null
*/
Type propertyGenericType();
/**
* Gets the style of the property, such as read-only, read-write or write-only.
*
* Rather than testing against specific values, it is strongly recommended to
* call the helper methods on the returned style.
*
* @return the property style, not null
*/
PropertyStyle style();
//-----------------------------------------------------------------------
/**
* Gets the annotations of the property.
*
* The annotations are queried from the property.
* This is typically accomplished by querying the annotations of the underlying instance variable.
*
* @return the annotations, unmodifiable, not null
*/
List annotations();
/**
* Gets an annotation from the property.
*
* The annotations are queried from the property.
* This is typically accomplished by querying the annotations of the underlying instance variable.
*
* @param the annotation type
* @param annotation the annotation class to find, not null
* @return the annotation, not null
* @throws NoSuchElementException if the annotation is not specified
*/
A annotation(Class annotation);
//-----------------------------------------------------------------------
/**
* Gets the value of the property for the specified bean.
*
* For a standard JavaBean, this is equivalent to calling getFoo() on the bean.
* Alternate implementations may perform any logic to obtain the value.
*
* @param bean the bean to query, not null
* @return the value of the property on the specified bean, may be null
* @throws ClassCastException if the bean is of an incorrect type
* @throws UnsupportedOperationException if the property is write-only
*/
@Override
P get(Bean bean);
/**
* Sets the value of the property on the specified bean.
*
* The value must be of the correct type for the property.
* For a standard JavaBean, this is equivalent to calling setFoo() on the bean.
* Alternate implementations may perform any logic to change the value.
*
* @param bean the bean to update, not null
* @param value the value to set into the property on the specified bean, may be null
* @throws ClassCastException if the bean is of an incorrect type
* @throws ClassCastException if the value is of an invalid type for the property
* @throws UnsupportedOperationException if the property is read-only
* @throws RuntimeException if the value is rejected by the property (use appropriate subclasses)
*/
void set(Bean bean, Object value);
/**
* Sets the value of the property on the associated bean and returns the previous value.
*
* The value must be of the correct type for the property.
* This is a combination of the {@code get} and {@code set} methods that matches the definition
* of {@code put} in a {@code Map}.
*
* @param bean the bean to update, not null
* @param value the value to set into the property on the specified bean, may be null
* @return the old value of the property, may be null
* @throws ClassCastException if the bean is of an incorrect type
* @throws ClassCastException if the value is of an invalid type for the property
* @throws UnsupportedOperationException if the property is read-only
* @throws RuntimeException if the value is rejected by the property (use appropriate subclasses)
*/
P put(Bean bean, Object value);
//-----------------------------------------------------------------------
/**
* Gets the value of the property for the specified bean converted to a string.
*
* This converts the result of {@link #get(Bean)} to a standard format string.
* Conversion uses Joda-Convert.
* Not all object types can be converted to a string, see Joda-Convert.
*
* For a standard JavaBean, this is equivalent to calling getFoo() on the bean.
* Alternate implementations may perform any logic to obtain the value.
*
* @param bean the bean to query, not null
* @return the value of the property on the specified bean, may be null
* @throws ClassCastException if the bean is of an incorrect type
* @throws UnsupportedOperationException if the property is write-only
* @throws RuntimeException if the value cannot be converted to a string (use appropriate subclasses)
*/
String getString(Bean bean);
/**
* Gets the value of the property for the specified bean converted to a string.
*
* This converts the result of {@link #get(Bean)} to a standard format string using the supplied converter.
* Not all object types can be converted to a string, see Joda-Convert.
*
* For a standard JavaBean, this is equivalent to calling getFoo() on the bean.
* Alternate implementations may perform any logic to obtain the value.
*
* @param bean the bean to query, not null
* @param stringConvert the converter to use, not null
* @return the value of the property on the specified bean, may be null
* @throws ClassCastException if the bean is of an incorrect type
* @throws UnsupportedOperationException if the property is write-only
* @throws RuntimeException if the value cannot be converted to a string (use appropriate subclasses)
*/
String getString(Bean bean, StringConvert stringConvert);
/**
* Sets the value of the property on the specified bean from a string by conversion.
*
* This converts the string to the correct type for the property and then sets it
* using {@link #set(Bean, Object)}. Conversion uses Joda-Convert.
*
* @param bean the bean to update, not null
* @param value the value to set into the property on the specified bean, may be null
* @throws ClassCastException if the bean is of an incorrect type
* @throws ClassCastException if the value is of an invalid type for the property
* @throws UnsupportedOperationException if the property is read-only
* @throws RuntimeException if the value is rejected by the property (use appropriate subclasses)
*/
void setString(Bean bean, String value);
/**
* Sets the value of the property on the specified bean from a string by conversion.
*
* This converts the string to the correct type for the property using the supplied converter and then sets it
* using {@link #set(Bean, Object)}.
*
* @param bean the bean to update, not null
* @param value the value to set into the property on the specified bean, may be null
* @param stringConvert the converter, not null
* @throws ClassCastException if the bean is of an incorrect type
* @throws ClassCastException if the value is of an invalid type for the property
* @throws UnsupportedOperationException if the property is read-only
* @throws RuntimeException if the value is rejected by the property (use appropriate subclasses)
*/
void setString(Bean bean, String value, StringConvert stringConvert);
//-----------------------------------------------------------------------
/**
* Checks if this meta-property equals another.
*
* This compares the property name and declaring type.
* It does not compare the property or bean types.
*
* @param obj the other meta-property, null returns false
* @return true if equal
*/
@Override
boolean equals(Object obj);
/**
* Returns a suitable hash code.
*
* @return the hash code
*/
@Override
int hashCode();
}