org.joda.beans.DynamicBean Maven / Gradle / Ivy
/*
* Copyright 2001-present 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;
/**
* A dynamic bean that allows properties to be added and removed.
*
* A JavaBean is defined at compile-time and cannot have additional properties added.
* Instances of this interface allow additional properties to be added and removed
* probably by wrapping a map
*/
public interface DynamicBean extends Bean {
/**
* Gets the meta-bean representing the parts of the bean that are
* common across all instances, such as the set of meta-properties.
*
* @return the meta-bean, not null
*/
@Override
public abstract DynamicMetaBean metaBean();
/**
* Gets a property by name.
*
* This will not throw an exception if the property name does not exist.
* Whether a property is immediately created or not is implementation dependent.
*
* @param the property type, optional, enabling auto-casting
* @param propertyName the property name to retrieve, not null
* @return the property, not null
*/
@Override
public abstract Property property(String propertyName);
/**
* Adds a property to those allowed to be stored in the bean.
*
* Some implementations will automatically add properties, in which case this
* method will have no effect.
*
* @param propertyName the property name to check, not empty, not null
* @param propertyType the property type, not null
*/
public abstract void propertyDefine(String propertyName, Class propertyType);
/**
* Removes a property by name.
*
* @param propertyName the property name to remove, null ignored
*/
public abstract void propertyRemove(String propertyName);
}