com.opensymphony.xwork.config.entities.ExternalReference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of webwork

There is a newer version: 2.2.5

/*
 * Copyright (c) 2002-2006 by OpenSymphony
 * All rights reserved.
 */
package com.opensymphony.xwork.config.entities;

import java.io.Serializable;


/**
 * Encapsulates an external reference in the xwork configuration.
 *
 * @author Ross
 * @author Rainer Hermanns
 */
public class ExternalReference implements Serializable {

    private String externalRef;
    private String name;
    private boolean required = true;


    /**
     * default constructor
     */
    public ExternalReference() {
    }

    /**
     * @param name        the name of the attribute the external reference refers to
     * @param externalRef the name used to query the external source
     * @param required    determines whether an exception should be thrown if the reference is not resolved
     */
    public ExternalReference(String name, String externalRef, boolean required) {
        this.name = name;
        this.externalRef = externalRef;
        this.required = required;
    }


    /**
     * @param externalRef The externalRef to set.
     */
    public void setExternalRef(String externalRef) {
        this.externalRef = externalRef;
    }

    /**
     * @return Returns the externalRef.
     */
    public String getExternalRef() {
        return externalRef;
    }

    /**
     * @param name The name to set.
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * @return Returns the name.
     */
    public String getName() {
        return name;
    }

    /**
     * @param required The required to set.
     */
    public void setRequired(boolean required) {
        this.required = required;
    }

    /**
     * @return Returns the required.
     */
    public boolean isRequired() {
        return required;
    }
}