org.joda.beans.PropertyStyle 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;
/**
* An enumeration of property styles.
*
* A property may be read-only, read-write or write-only.
* This enumeration models those options.
*
* It is strongly recommended to use the methods, not compare against the enum values.
*/
public enum PropertyStyle {
/**
* The property can be read and written.
*/
READ_WRITE,
/**
* The property is read-only.
*/
READ_ONLY,
/**
* The property is write-only.
*/
WRITE_ONLY,
/**
* The property is read-only but can be written via the builder.
*/
READ_ONLY_BUILDABLE,
/**
* The property is derived.
* It is read-only.
*/
DERIVED,
/**
* The property is immutable.
* It can be read and written via the builder.
*/
IMMUTABLE;
//-----------------------------------------------------------------------
/**
* Checks whether the property is readable.
*
* This checks if the property get method will succeed.
*
* @return true if the property can be read
*/
public boolean isReadable() {
return this == READ_WRITE || this == READ_ONLY || this == READ_ONLY_BUILDABLE || this == DERIVED || this == IMMUTABLE;
}
/**
* Checks whether the property is writable.
*
* This checks if the property set method will succeed.
*
* @return true if the property can be written
*/
public boolean isWritable() {
return this == READ_WRITE || this == WRITE_ONLY;
}
/**
* Checks whether the property is read-only.
*
* This checks if the property get method will succeed and the set method fail.
* Read-only, derived and immutable properties will return true.
* Note that an immutable property can be written via the builder.
*
* @return true if the property is derived
*/
public boolean isReadOnly() {
return this == READ_ONLY || this == READ_ONLY_BUILDABLE || this == DERIVED || this == IMMUTABLE;
}
/**
* Checks whether the property can be used in the builder.
*
* To check for round-trip behavior, use {@link #isSerializable()}.
*
* @return true if the property can be used in the builder
*/
public boolean isBuildable() {
return this == READ_WRITE || this == WRITE_ONLY || this == READ_ONLY_BUILDABLE || this == IMMUTABLE;
}
/**
* Checks whether the property is derived.
*
* A derived property has no instance variable.
*
* @return true if the property is derived
*/
public boolean isDerived() {
return this == DERIVED;
}
/**
* Checks whether the property can be serialized in a round-trip.
*
* A property that is read-write or immutable can be round-trip serialized.
*
* @return true if the property is serializable
*/
public boolean isSerializable() {
return this == READ_WRITE || this == READ_ONLY_BUILDABLE || this == IMMUTABLE;
}
}