org.identityconnectors.framework.common.objects.SyncDeltaBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of framework Show documentation
The newest version!
/*
 * ====================
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.     
 * 
 * The contents of this file are subject to the terms of the Common Development 
 * and Distribution License("CDDL") (the "License").  You may not use this file 
 * except in compliance with the License.
 * 
 * You can obtain a copy of the License at 
 * http://IdentityConnectors.dev.java.net/legal/license.txt
 * See the License for the specific language governing permissions and limitations 
 * under the License. 
 * 
 * When distributing the Covered Code, include this CDDL Header Notice in each file
 * and include the License file at identityconnectors/legal/license.txt.
 * If applicable, add the following below this CDDL Header, with the fields 
 * enclosed by brackets [] replaced by your own identifying information: 
 * "Portions Copyrighted [year] [name of copyright owner]"
 * ====================
 */
package org.identityconnectors.framework.common.objects;

/**
 * Builder for {@link SyncDelta}.
 */
public final class SyncDeltaBuilder {
    private SyncToken _token;
    private SyncDeltaType _deltaType;
    private Uid _previousUid;
    private Uid _uid;
    private ConnectorObject _object;

    /**
     * Create a new SyncDeltaBuilder
     */
    public SyncDeltaBuilder() {

    }

    /**
     * Creates a new SyncDeltaBuilder whose values are
     * initialized to those of the delta.
     * 
     * @param delta
     *            The original delta.
     */
    public SyncDeltaBuilder(SyncDelta delta) {
        _token = delta.getToken();
        _deltaType = delta.getDeltaType();
        _object = delta.getObject();
        _previousUid = delta.getPreviousUid();
        _uid = delta.getUid();
    }

    /**
     * Returns the SyncToken of the object that changed.
     * 
     * @return the SyncToken of the object that changed.
     */
    public SyncToken getToken() {
        return _token;
    }

    /**
     * Sets the SyncToken of the object that changed.
     * 
     * @param token
     *            the SyncToken of the object that changed.
     */
    public SyncDeltaBuilder setToken(SyncToken token) {
        _token = token;
        return this;
    }

    /**
     * Returns the type of the change that occurred.
     * 
     * @return The type of change that occurred.
     */
    public SyncDeltaType getDeltaType() {
        return _deltaType;
    }

    /**
     * Sets the type of the change that occurred.
     * 
     * @param type
     *            The type of change that occurred.
     */
    public SyncDeltaBuilder setDeltaType(SyncDeltaType type) {
        _deltaType = type;
        return this;
    }

    /**
     * Gets the Uid of the object before the change.
     * 
     * @return The Uid of the object before the change.
     */
    public Uid getPreviousUid() {
        return _previousUid;
    }

    /**
     * Sets the Uid of the object before the change.
     * 
     * @param previousUid
     *           The Uid of the object before the change.
     */
    public void setPreviousUid(Uid previousUid) {
        _previousUid = previousUid;
    }

    /**
     * Gets the Uid of the object that changed
     * 
     * @return The Uid of the object that changed.
     */
    public Uid getUid() {
        return _uid;
    }

    /**
     * Sets the Uid of the object that changed. Note that this is implicitly set
     * when you call {@link #setObject(ConnectorObject)}.
     * 
     * @param uid
     *            The Uid of the object that changed.
     */
    public SyncDeltaBuilder setUid(Uid uid) {
        _uid = uid;
        return this;
    }

    /**
     * Returns the object that changed.
     * 
     * @return The object that changed. May be null for deletes.
     */
    public ConnectorObject getObject() {
        return _object;
    }

    /**
     * Sets the object that changed and implicitly sets Uid if object is not
     * null.
     * 
     * @param object
     *            The object that changed. May be null for deletes.
     */
    public SyncDeltaBuilder setObject(ConnectorObject object) {
        _object = object;
        if (object != null) {
            _uid = object.getUid();
        }
        return this;
    }

    /**
     * Creates a SyncDelta. Prior to calling the following must be specified:
     * 
     * {@link #setObject(ConnectorObject) Object} (for anything other than
     * delete)
     * {@link #setUid(Uid) Uid} (this is implictly set when calling
     * {@link #setObject(ConnectorObject)})
     * {@link #setToken(SyncToken) Token}
     * {@link #setDeltaType(SyncDeltaType) DeltaType}
     * 
     */
    public SyncDelta build() {
        return new SyncDelta(_token, _deltaType, _previousUid, _uid, _object);
    }
}