xpertss.sdp.Attribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdp Show documentation
Session Description Protocol implementation
The newest version!
/*
 * Attribute.java
 *
 * Created on December 18, 2001, 10:55 AM
 */

package xpertss.sdp;

import xpertss.lang.Objects;
import xpertss.lang.Strings;

/**
 * An Attribute represents an a= fields contained within either a MediaDescription or
 * a SessionDescription.
 * 
 * An Attribute can be just an identity/name or a name-value pair.
 * 

 * Here are some examples:
 * 
 *    a=recvonly
 *       identifies a rcvonly attribute with just a name
 *    a=rtpmap:0 PCMU/8000
 *       identifies the media format 0 has having the value PCMU/8000.
 * 
 *
 * @version 1.0
 */
public final class Attribute extends Field {

   private String name;
   private String value;

   Attribute(String name, String value)
   {
      this.name = Strings.notEmpty(name, "name may not be empty");
      this.value = Strings.nullIfEmpty(Strings.trim(value));
   }
    
   /**
    * Returns the name of this attribute
    *
    * @return a String identity.
    */
   public String getName()
   {
      return name;
   }
    
   /**
    * Returns the value of this attribute.
    *
    * @return the value; null if the attribute has no associated value.
    */
   public String getValue()
   {
      return value;
   }


   @Override
   public char getTypeChar()
   {
      return 'a';
   }

   @Override
   public Attribute clone() {
      try {
         return (Attribute) super.clone();
      } catch(CloneNotSupportedException e) {
         throw new Error(e);
      }
   }


   @Override
   public int hashCode()
   {
      return Objects.hash(name, value);
   }

   @Override
   public boolean equals(Object o)
   {
      if(o instanceof Attribute) {
         Attribute attr = (Attribute) o;
         return Objects.equal(attr.getName(), name) && Objects.equal(attr.getValue(), value);
      }
      return false;
   }


   @Override
   public String toString()
   {
      StringBuilder buf = new StringBuilder();
      buf.append(getTypeChar()).append("=").append(name);
      if(!Strings.isEmpty(value)) buf.append(":").append(value);
      return buf.toString();
   }

}