Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.sun.syndication.feed.impl
Class ObjectBean  view ObjectBean download ObjectBean.java

java.lang.Object
  extended bycom.sun.syndication.feed.impl.ObjectBean
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class ObjectBean
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

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.


Field Summary
private  CloneableBean _cloneableBean
           
private  EqualsBean _equalsBean
           
private  ToStringBean _toStringBean
           
 
Constructor Summary
ObjectBean(java.lang.Class beanClass, java.lang.Object obj)
          Constructor.
ObjectBean(java.lang.Class beanClass, java.lang.Object obj, java.util.Set ignoreProperties)
          Constructor.
 
Method Summary
 java.lang.Object clone()
          Creates a deep 'bean' clone of the object.
 boolean equals(java.lang.Object other)
          Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
 int hashCode()
          Returns a hashcode value for the object.
 java.lang.String toString()
          Returns the String representation for the object.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

_equalsBean

private EqualsBean _equalsBean

_toStringBean

private ToStringBean _toStringBean

_cloneableBean

private CloneableBean _cloneableBean
Constructor Detail

ObjectBean

public ObjectBean(java.lang.Class beanClass,
                  java.lang.Object obj)
Constructor.


ObjectBean

public ObjectBean(java.lang.Class beanClass,
                  java.lang.Object obj,
                  java.util.Set ignoreProperties)
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.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Creates a deep 'bean' clone of the object.


equals

public boolean equals(java.lang.Object other)
Indicates whether some other object is "equal to" this one as defined by the Object equals() method.


hashCode

public int hashCode()
Returns a hashcode value for the object.

It follows the contract defined by the Object hashCode() method.


toString

public java.lang.String toString()
Returns the String representation for the object.