org.puremvc.java.patterns.proxy.Proxy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of PureMVC Show documentation

PureMVC is a lightweight framework for creating applications based upon the classic Model-View-Controller design meta-pattern. This is the specific implementation for the Java language. It does not support modular programming since it uses Singletons as Core actors rather than the Multiton used in the MultiCore Version.

The newest version!

//
//  PureMVC Java Standard
//
//  Copyright(c) 2019 Saad Shams 
//  Your reuse is governed by the Creative Commons Attribution 3.0 License
//

package org.puremvc.java.patterns.proxy;

import org.puremvc.java.interfaces.IProxy;
import org.puremvc.java.patterns.observer.Notifier;

/**
 * A base IProxy implementation.
 *
 * In PureMVC, Proxy classes are used to manage parts of the
 * application's data model.
 *
 * A Proxy might simply manage a reference to a local data
 * object, in which case interacting with it might involve setting and getting
 * of its data in synchronous fashion.
 *
 * Proxy classes are also used to encapsulate the application's
 * interaction with remote services to save or retrieve data, in which case, we
 * adopt an asyncronous idiom; setting data (or calling a method) on the
 * Proxy and listening for a Notification to be
 * sent when the Proxy has retrieved the data from the service.
 *
 * @see org.puremvc.java.core.Model Model
 */
public class Proxy extends Notifier implements IProxy {

    // the proxy name
    public static final String NAME = "Proxy";

    // the data object
    protected String proxyName;

    // the data object
    protected Object data;

    /**
     * Constructor
     *
     * @param proxyName proxy name
     * @param data data object
     */
    public Proxy(String proxyName, Object data) {
        this.proxyName = (proxyName != null) ? proxyName : NAME;
        if(data != null) setData(data);
    }

    /**
     * Constructor
     *
     * @param proxyName Name of the Proxy
     */
    public Proxy(String proxyName) {
        this(proxyName, null);
    }

    /**
     * Constructor
     */
    public Proxy(){
        this(null, null);
    }

    /**
     * Called by the Model when the Proxy is registered
     */
    public void onRegister() {

    }

    /**
     * Called by the Model when the Proxy is removed
     */
    public void onRemove() {

    }

    /**
     * Get the proxy name
     *
     * @return the proxy name
     */
    public String getProxyName() {
        return proxyName;
    }

    /**
     * Get the data object
     *
     * @return the data object
     */
    public Object getData() {
        return data;
    }

    /**
     * Set the data object
     *
     * @param data data object
     */
    public void setData(Object data) {
        this.data = data;
    }

}