org.bson.codecs.pojo.PropertyModel Maven / Gradle / Ivy
/*
* Copyright 2017 MongoDB, 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 org.bson.codecs.pojo;
import org.bson.codecs.Codec;
/**
* Represents a property on a class and stores various metadata such as generic parameters
*
* @param the type of the property that the PropertyModel represents.
* @since 3.5
*/
public final class PropertyModel {
private final String name;
private final String readName;
private final String writeName;
private final TypeData typeData;
private final Codec codec;
private final PropertySerialization propertySerialization;
private final Boolean useDiscriminator;
private final PropertyAccessor propertyAccessor;
private volatile Codec cachedCodec;
PropertyModel(final String name, final String readName, final String writeName, final TypeData typeData,
final Codec codec, final PropertySerialization propertySerialization, final Boolean useDiscriminator,
final PropertyAccessor propertyAccessor) {
this.name = name;
this.readName = readName;
this.writeName = writeName;
this.typeData = typeData;
this.codec = codec;
this.cachedCodec = codec;
this.propertySerialization = propertySerialization;
this.useDiscriminator = useDiscriminator;
this.propertyAccessor = propertyAccessor;
}
/**
* Create a new {@link PropertyModelBuilder}
* @param the type of the property
* @return the builder
*/
public static PropertyModelBuilder builder() {
return new PropertyModelBuilder();
}
/**
* @return the property name for the model
*/
public String getName() {
return name;
}
/**
* @return the name of the property to use as the key when deserializing from BSON
*/
public String getWriteName() {
return writeName;
}
/**
* @return the name of the property to use as the key when serializing into BSON
*/
public String getReadName() {
return readName;
}
/**
* Property is writable.
*
* @return true if can be deserialized from BSON
*/
public boolean isWritable() {
return writeName != null;
}
/**
* Property is readable.
*
* @return true if can be serialized to BSON
*/
public boolean isReadable() {
return readName != null;
}
/**
* @return the type data for the property
*/
public TypeData getTypeData() {
return typeData;
}
/**
* @return the custom codec to use if set or null
*/
public Codec getCodec() {
return codec;
}
/**
* Returns true if the value should be serialized.
*
* @param value the value to check
* @return true if the value should be serialized.
*/
public boolean shouldSerialize(final T value) {
return propertySerialization.shouldSerialize(value);
}
/**
* @return the property accessor
*/
public PropertyAccessor getPropertyAccessor() {
return propertyAccessor;
}
/**
* @return true or false if a discriminator should be used when serializing or null if not set
*/
public Boolean useDiscriminator() {
return useDiscriminator;
}
@Override
public String toString() {
return "PropertyModel{"
+ "propertyName='" + name + "'"
+ ", readName='" + readName + "'"
+ ", writeName='" + writeName + "'"
+ ", typeData=" + typeData
+ "}";
}
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
PropertyModel that = (PropertyModel) o;
if (getName() != null ? !getName().equals(that.getName()) : that.getName() != null) {
return false;
}
if (getReadName() != null ? !getReadName().equals(that.getReadName()) : that.getReadName() != null) {
return false;
}
if (getWriteName() != null ? !getWriteName().equals(that.getWriteName()) : that.getWriteName() != null) {
return false;
}
if (getTypeData() != null ? !getTypeData().equals(that.getTypeData()) : that.getTypeData() != null) {
return false;
}
if (getCodec() != null ? !getCodec().equals(that.getCodec()) : that.getCodec() != null) {
return false;
}
if (getPropertySerialization() != null ? !getPropertySerialization().equals(that.getPropertySerialization()) : that
.getPropertySerialization() != null) {
return false;
}
if (useDiscriminator != null ? !useDiscriminator.equals(that.useDiscriminator) : that.useDiscriminator != null) {
return false;
}
if (getPropertyAccessor() != null ? !getPropertyAccessor().equals(that.getPropertyAccessor())
: that.getPropertyAccessor() != null) {
return false;
}
if (getCachedCodec() != null ? !getCachedCodec().equals(that.getCachedCodec()) : that.getCachedCodec() != null) {
return false;
}
return true;
}
@Override
public int hashCode() {
int result = getName() != null ? getName().hashCode() : 0;
result = 31 * result + (getReadName() != null ? getReadName().hashCode() : 0);
result = 31 * result + (getWriteName() != null ? getWriteName().hashCode() : 0);
result = 31 * result + (getTypeData() != null ? getTypeData().hashCode() : 0);
result = 31 * result + (getCodec() != null ? getCodec().hashCode() : 0);
result = 31 * result + (getPropertySerialization() != null ? getPropertySerialization().hashCode() : 0);
result = 31 * result + (useDiscriminator != null ? useDiscriminator.hashCode() : 0);
result = 31 * result + (getPropertyAccessor() != null ? getPropertyAccessor().hashCode() : 0);
result = 31 * result + (getCachedCodec() != null ? getCachedCodec().hashCode() : 0);
return result;
}
PropertySerialization getPropertySerialization() {
return propertySerialization;
}
void cachedCodec(final Codec codec) {
this.cachedCodec = codec;
}
Codec getCachedCodec() {
return cachedCodec;
}
}