com.techempower.gemini.context.Delivery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemini Show documentation
Gemini is a web framework created by TechEmpower.
There is a newer version: 3.3.14
/*******************************************************************************
 * Copyright (c) 2018, TechEmpower, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name TechEmpower, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL TECHEMPOWER, INC. BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************/
package com.techempower.gemini.context;

import java.util.*;

import com.techempower.collection.*;
import com.techempower.gemini.*;

/**
 * A map of named objects/values delivered to a view by a Handler.  A Context
 * carries a Delivery during its lifespan.  A reference is fetched via
 * context.delivery().
 */
public class Delivery
     extends MutableNamedObjects
{

  /**
   * Constructor.
   */
  public Delivery()
  {
    super();
  }
  
  /**
   * Adds a delivery named "status".
   */
  public Delivery status(String value)
  {
    put(GeminiConstants.GEMINI_STATUS, value);
    return this;
  }
  
  /**
   * Adds a delivery named "message".
   */
  public Delivery message(String value)
  {
    put(GeminiConstants.GEMINI_MESSAGE, value);
    return this;
  }
  
  /**
   * Adds a delivery named "validation".
   */
  public Delivery validation(Object value)
  {
    putObject(GeminiConstants.GEMINI_FORM_VALIDATION, value);
    return this;
  }
  
  @Override
  public Delivery putObject(String name, Object value)
  {
    // Throw a runtime exception if either the name or object are null.
    if (  (value == null)
       || (name == null)
       )
    {
      throw new IllegalArgumentException(
          "context.putDelivery does not support null keys or values (" 
          + name + ": " + value + ")");
    }
    
    return (Delivery)super.putObject(name, value);
  }
  
  /**
   * Put all of the provided named objects into the Delivery map.
   */
  public Delivery putAll(Map map)
  {
    for (Map.Entry entry : map.entrySet())
    {
      this.putObject(entry.getKey(), entry.getValue());
    }
    
    return this;
  }
  
}