org.efaps.admin.event.Return Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright 2003 - 2012 The eFaps Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Revision:        $Rev: 7483 $
 * Last Changed:    $Date: 2012-05-11 11:57:38 -0500 (Fri, 11 May 2012) $
 * Last Changed By: $Author: [email protected] $
 */

package org.efaps.admin.event;

import java.util.HashMap;
import java.util.Map;
import java.util.Set;

import org.apache.commons.lang.builder.ToStringBuilder;

/**
 * Class witch is used for getting the Return of the Events.
 *
 * @author The eFaps Team
 * @version $Id: Return.java 7483 2012-05-11 16:57:38Z [email protected] $
 */
public class Return
{
    /**
     * Enumeration for the kind of returned values.
     */
    public enum ReturnValues
    {
        /** Used to return code sniplett that will be represented as is. */
        SNIPLETT,
        /** Used to return a Map of Values. */
        VALUES,
        /** Used to return true. */
        TRUE;
    }

    /**
     * Map with all returned values.
     */
    private final Map map = new HashMap();

    /**
     *
     * @param _key  searched key
     * @return found object or null if not found
     */
    public Object get(final Return.ReturnValues _key)
    {
        return this.map.get(_key);
    }

    /**
     *
     * @param _key      key to set
     * @param _value    value to set
     */
    public void put(final Return.ReturnValues _key,
                    final Object _value)
    {
        this.map.put(_key, _value);
    }

    /**
     *
     * @return set of all values depending on the {@link ReturnValues}
     */
    public Set> entrySet()
    {
        return this.map.entrySet();
    }

    /**
     *
     * @return true if the {@link #map} of returned value is empty;
     *         otherwise false
     * @see #map
     */
    public boolean isEmpty()
    {
        return this.map.isEmpty();
    }

    /**
     *
     * @param _key  searched key
     * @return true if the _key is defined in the
     *         {@link #map}; otherwise false
     * @see #map
     */
    public boolean contains(final Return.ReturnValues _key)
    {
        return this.map.containsKey(_key);
    }

    /**
     * Returns a string representation of this parameter instance.
     *
     * @return string representation of this parameter instance.
     */
    @Override
    public String toString()
    {
        return new ToStringBuilder(this)
            .appendSuper(super.toString())
            .append("map", this.map.toString())
            .toString();
    }
}