asia.stampy.common.message.AbstractMessageHeader Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of stampy-core Show documentation
Java implementation of the STOMP 1.2 specification
The newest version!
/*
 * Copyright (C) 2013 Burton Alexander
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * 
 */
package asia.stampy.common.message;

import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;

import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;

import asia.stampy.common.StampyLibrary;

/**
 * Abstract implementation of a {@link StampyMessageHeader}.
 */
@StampyLibrary(libraryName="stampy-core")
public abstract class AbstractMessageHeader implements StampyMessageHeader {

  private static final long serialVersionUID = 4570408820942642173L;

  /** The Constant CONTENT_LENGTH. */
  public static final String CONTENT_LENGTH = "content-length";

  private Map headers = new HashMap();

  /**
   * Sets the content length.
   * 
   * @param length
   *          the new content length
   */
  public void setContentLength(int length) {
    addHeader(CONTENT_LENGTH, Integer.toString(length));
  }

  /**
   * Gets the content length.
   * 
   * @return the content length
   */
  public int getContentLength() {
    String length = getHeaderValue(CONTENT_LENGTH);
    if (length == null) return -1;

    return Integer.parseInt(length);
  }

  /**
   * If a client or a server receives repeated frame header entries, only the
   * first header entry SHOULD be used as the value of header entry. Subsequent
   * values are only used to maintain a history of state changes of the header
   * and MAY be ignored.

   * 

   * If addHeader is invoked when the key specified is already in use the value
   * is NOT updated. To replace an existing key-value, first use the
   * 
   * @param key
   *          the key
   * @param value
   *          the value {@link AbstractMessageHeader#removeHeader(String)}
   *          method.
   */
  @Override
  public void addHeader(String key, String value) {
    if (!hasHeader(key)) headers.put(key, value);
  }

  /*
   * (non-Javadoc)
   * 
   * @see
   * asia.stampy.common.message.StampyMessageHeader#removeHeader(java.lang.String
   * )
   */
  @Override
  public void removeHeader(String key) {
    headers.remove(key);
  }

  /*
   * (non-Javadoc)
   * 
   * @see
   * asia.stampy.common.message.StampyMessageHeader#getHeaderValue(java.lang
   * .String)
   */
  @Override
  public String getHeaderValue(String key) {
    return headers.get(key);
  }

  /*
   * (non-Javadoc)
   * 
   * @see
   * asia.stampy.common.message.StampyMessageHeader#hasHeader(java.lang.String)
   */
  @Override
  public boolean hasHeader(String key) {
    return headers.containsKey(key);
  }

  /*
   * (non-Javadoc)
   * 
   * @see asia.stampy.common.message.StampyMessageHeader#toMessageHeader()
   */
  @Override
  public final String toMessageHeader() {
    boolean first = true;

    StringBuilder builder = new StringBuilder();
    for (Entry entry : headers.entrySet()) {
      if (!first) builder.append("\n");

      builder.append(entry.getKey());
      builder.append(":");
      builder.append(entry.getValue());

      first = false;
    }

    return builder.toString();
  }

  /*
   * (non-Javadoc)
   * 
   * @see asia.stampy.common.message.StampyMessageHeader#getHeaders()
   */
  @Override
  public Map getHeaders() {
    return new HashMap(headers);
  }

  /*
   * (non-Javadoc)
   * 
   * @see java.lang.Object#equals(java.lang.Object)
   */
  @Override
  public boolean equals(Object o) {
    return EqualsBuilder.reflectionEquals(this, o);
  }

  /*
   * (non-Javadoc)
   * 
   * @see java.lang.Object#hashCode()
   */
  @Override
  public int hashCode() {
    return HashCodeBuilder.reflectionHashCode(this);
  }

  /*
   * (non-Javadoc)
   * 
   * @see java.lang.Object#toString()
   */
  @Override
  public String toString() {
    return toMessageHeader();
  }

}