net.sixpointsix.carpo.common.model.immutable.AbstractImmutableCarpoPropertyEntity Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of carpo-common Show documentation

Common until library for carpo

There is a newer version: 0.7.0

package net.sixpointsix.carpo.common.model.immutable;

import net.sixpointsix.carpo.common.model.CarpoPropertyEntity;
import net.sixpointsix.carpo.common.model.PropertyCollection;
import net.sixpointsix.carpo.common.model.Timestamp;

/**
 * Parent class for properties entities that need to be immutable
 *
 * @author Andrew Tarry
 * @since 0.0.1
 */
abstract public class AbstractImmutableCarpoPropertyEntity implements CarpoPropertyEntity {

    private final String carpoId;
    private final Timestamp timestamp;
    private final PropertyCollection properties;

    public AbstractImmutableCarpoPropertyEntity(String carpoId, Timestamp timestamp, PropertyCollection properties) {
        this.carpoId = carpoId;
        this.timestamp = timestamp;
        this.properties = properties;
    }

    /**
     * Get the entity id as a string
     * 
     * The Carpo entity interface has no opinion on the format of the id. It could be a number, UUID or something else
     * but it must be able to be represented as a string
     * 
     * 
     * This method uses the carpoId not just id because some systems will already be using a getId method
     * 
     *
     * @return Entity ID
     */
    @Override
    public String getCarpoId() {
        return carpoId;
    }

    /**
     * Get the timestamp associated with the entity
     *
     * 
     * A Capo entity should have a timestamp linked with if for audit purposes but it is not a essential
     * 
     *
     * @return Timestamp
     */
    @Override
    public Timestamp getTimestamp() {
        return timestamp;
    }

    /**
     * Get the set of properties for the entity
     *
     * 
     * This method should never return null. If there are no properties an empty collection should be returned
     * 
     *
     * @return PropertyCollection
     */
    @Override
    public PropertyCollection getProperties() {
        return properties;
    }
}