org.joda.beans.impl.BasicBean 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.impl;
import org.joda.beans.Bean;
import org.joda.beans.JodaBeanUtils;
/**
* Basic implementation of {@code Bean} intended for applications to subclass.
*
* The subclass must to provide an implementation for {@link Bean#metaBean()}.
* This returns the complete definition of the bean at the meta level.
*
* @author Stephen Colebourne
*/
public abstract class BasicBean implements Bean {
/**
* Clones this bean, returning an independent copy.
*
* @return the clone, not null
*/
@Override
public BasicBean clone() {
return JodaBeanUtils.clone(this);
}
/**
* Checks if this bean equals another.
*
* This compares the class and all the properties of the bean.
*
* @param obj the object to compare to, null returns false
* @return true if the beans are equal
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj != null && getClass() == obj.getClass()) {
Bean other = (Bean) obj;
return JodaBeanUtils.propertiesEqual(this, other);
}
return false;
}
/**
* Returns a suitable hash code.
*
* The hash code is derived from all the properties of the bean.
*
* @return a suitable hash code
*/
@Override
public int hashCode() {
return getClass().hashCode() ^ JodaBeanUtils.propertiesHashCode(this);
}
/**
* Returns a string that summarises the bean.
*
* The string contains the class name and properties.
*
* @return a summary string, not null
*/
@Override
public String toString() {
return JodaBeanUtils.propertiesToString(this, metaBean().beanType().getSimpleName());
}
}