net.sixpointsix.carpo.common.model.AbstractPropertyEntityBuilder 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;

import net.sixpointsix.carpo.common.model.immutable.ImmutableTimestamp;
import net.sixpointsix.carpo.common.model.mutable.MutablePropertyCollection;

/**
 * Parent for builder classes to make it easier to create entities
 * @param  entity class to be built
 * @author Andrew Tarry
 * @since 0.0.1
 */
abstract public class AbstractPropertyEntityBuilder {

    protected String carpoId;
    protected Timestamp timestamp;
    protected PropertyCollection properties = new MutablePropertyCollection();

    /**
     * Build the entity
     * @return entity
     */
    public abstract T build();

    /**
     * Set the Id
     *
     * @param carpoId Carpo ID value
     */
    public void setCarpoId(String carpoId) {
        this.carpoId = carpoId;
    }

    /**
     * Set the timestamp
     *
     * @param timestamp Timestamp to set
     */
    public void setTimestamp(Timestamp timestamp) {
        this.timestamp = timestamp;
    }

    /**
     * Set the timestamp with the current time as the values
     */
    public void setTimestampToNow() {
        this.timestamp = ImmutableTimestamp.build();
    }

    /**
     * Add a property
     *
     * @param property property to add
     */
    public void addProperty(Property property) {
        this.properties.add(property);
    }
}