org.joda.beans.BeanBuilder 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 builder for a bean, providing a safe way to create it.
*
* This interface allows a bean to be created even if it is immutable.
*
* @param the type of the bean
* @author Stephen Colebourne
*/
public interface BeanBuilder {
/**
* Gets the value of a single property previously added to the builder.
*
* @param propertyName the property name to query, not null
* @return the previously set value, null if none
* @throws RuntimeException thrown if the property name is invalid
*/
public abstract Object get(String propertyName);
/**
* Gets the value of a single property previously added to the builder.
*
* @param metaProperty the meta-property to query, not null
* @return the previously set value, null if none
* @throws RuntimeException thrown if the property is invalid
* @param the type of the property.
*/
public abstract
P get(MetaProperty
metaProperty);
/**
* Sets the value of a single property into the builder.
*
* This will normally behave as per a {@code Map}, however it may not
* and as a general rule callers should only set each property once.
*
* @param propertyName the property name to set, not null
* @param value the property value, may be null
* @return {@code this}, for chaining, not null
* @throws RuntimeException optionally thrown if the property name is invalid
*/
public abstract BeanBuilder set(String propertyName, Object value);
/**
* Sets the value of a single property into the builder.
*
* This will normally behave as per a {@code Map}, however it may not
* and as a general rule callers should only set each property once.
*
* @param metaProperty the meta-property to set, not null
* @param value the property value, may be null
* @return {@code this}, for chaining, not null
* @throws RuntimeException optionally thrown if the property is invalid
*/
public abstract BeanBuilder set(MetaProperty metaProperty, Object value);
/**
* Builds the bean from the state of the builder.
*
* Once this method has been called, the builder is in an invalid state.
* The effect of further method calls is undetermined.
*
* @return the created bean, not null
*/
public abstract T build();
}