com.rometools.rome.feed.impl.ObjectBean Maven / Gradle / Ivy
/*
* Copyright 2004 Sun Microsystems, 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.rometools.rome.feed.impl;
import java.io.Serializable;
import java.util.Set;
/**
* Convenience class providing clone(), toString(), equals() and hashCode() functionality for Java
* Beans.
*
* It works on all read/write properties, recursively.
*
* It uses the CloneableBean, EqualsBean and ToStringBean classes in a delegation pattern.
*
*
ObjectBean programming conventions
*
* All ObjectBean subclasses having properties that return collections they should never return null
* if the property has been set to null or if a collection has not been set. They should
* create and return an empty collection, this empty collection instance should also be set to the
* corresponding property.
*
* All ObjectBean subclasses properties should be live references.
*/
public class ObjectBean implements Serializable, Cloneable {
private static final long serialVersionUID = 1L;
private final EqualsBean equalsBean;
private final ToStringBean toStringBean;
private final CloneableBean cloneableBean;
/**
* @param beanClass the class/interface to be used for property scanning.
*
*/
public ObjectBean(final Class beanClass, final Object obj) {
this(beanClass, obj, null);
}
/**
* Constructor.
*
* The property names in the ignoreProperties Set will not be copied into the cloned instance.
* This is useful for cases where the Bean has convenience properties (properties that are
* actually references to other properties or properties of properties). For example SyndFeed
* and SyndEntry beans have convenience properties, publishedDate, author, copyright and
* categories all of them mapped to properties in the DC Module.
*
*
* @param beanClass the class/interface to be used for property scanning.
* @param ignoreProperties properties to ignore when cloning.
*
*/
public ObjectBean(final Class beanClass, final Object obj, final Set ignoreProperties) {
equalsBean = new EqualsBean(beanClass, obj);
toStringBean = new ToStringBean(beanClass, obj);
cloneableBean = new CloneableBean(obj, ignoreProperties);
}
/**
* Creates a deep 'bean' clone of the object.
*
*
* @return a clone of the object.
* @throws CloneNotSupportedException thrown if an element of the object cannot be cloned.
*
*/
@Override
public Object clone() throws CloneNotSupportedException {
return cloneableBean.beanClone();
}
/**
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
*
*
* @param other he reference object with which to compare.
* @return true if 'this' object is equal to the 'other' object.
*
*/
@Override
public boolean equals(final Object other) {
return equalsBean.beanEquals(other);
}
/**
* Returns a hashcode value for the object.
*
* It follows the contract defined by the Object hashCode() method.
*
*
* @return the hashcode of the bean object.
*
*/
@Override
public int hashCode() {
return equalsBean.beanHashCode();
}
/**
* Returns the String representation for the object.
*
*
* @return String representation for the object.
*
*/
@Override
public String toString() {
return toStringBean.toString();
}
}