Class MimeTypeParameterList


  • public class MimeTypeParameterList
    extends java.lang.Object
    A parameter list of a MimeType as defined in RFC 2045 and 2046. The Primary type of the object must already be stripped off.
    See Also:
    MimeType
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Hashtable<java.lang.String,​java.lang.String> parameters  
      private static java.lang.String TSPECIALS
      A string that holds all the special chars.
    • Constructor Summary

      Constructors 
      Constructor Description
      MimeTypeParameterList()
      Default constructor.
      MimeTypeParameterList​(java.lang.String parameterList)
      Constructs a new MimeTypeParameterList with the passed in data.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String get​(java.lang.String name)
      Retrieve the value associated with the given name, or null if there is no current association.
      java.util.Enumeration<java.lang.String> getNames()
      Retrieve an enumeration of all the names in this list.
      boolean isEmpty()
      Determine whether or not this list is empty.
      private static boolean isTokenChar​(char c)
      Determine whether or not a given character belongs to a legal token.
      protected void parse​(java.lang.String parameterList)
      A routine for parsing the parameter list out of a String.
      private static java.lang.String quote​(java.lang.String value)
      A routine that knows how and when to quote and escape the given value.
      void remove​(java.lang.String name)
      Remove any value associated with the given name.
      void set​(java.lang.String name, java.lang.String value)
      Set the value to be associated with the given name, replacing any previous association.
      int size()
      Return the number of name-value pairs in this list.
      private static int skipWhiteSpace​(java.lang.String rawdata, int i)
      return the index of the first non white space character in rawdata at or after index i.
      java.lang.String toString()
      Return a string representation of this object.
      private static java.lang.String unquote​(java.lang.String value)
      A routine that knows how to strip the quotes and escape sequences from the given value.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • parameters

        private java.util.Hashtable<java.lang.String,​java.lang.String> parameters
      • TSPECIALS

        private static final java.lang.String TSPECIALS
        A string that holds all the special chars.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MimeTypeParameterList

        public MimeTypeParameterList()
        Default constructor.
      • MimeTypeParameterList

        public MimeTypeParameterList​(java.lang.String parameterList)
                              throws MimeTypeParseException
        Constructs a new MimeTypeParameterList with the passed in data.
        Parameters:
        parameterList - an RFC 2045, 2046 compliant parameter list.
        Throws:
        MimeTypeParseException - if the MIME type can't be parsed
    • Method Detail

      • parse

        protected void parse​(java.lang.String parameterList)
                      throws MimeTypeParseException
        A routine for parsing the parameter list out of a String.
        Parameters:
        parameterList - an RFC 2045, 2046 compliant parameter list.
        Throws:
        MimeTypeParseException - if the MIME type can't be parsed
      • size

        public int size()
        Return the number of name-value pairs in this list.
        Returns:
        the number of parameters
      • isEmpty

        public boolean isEmpty()
        Determine whether or not this list is empty.
        Returns:
        true if there are no parameters
      • get

        public java.lang.String get​(java.lang.String name)
        Retrieve the value associated with the given name, or null if there is no current association.
        Parameters:
        name - the parameter name
        Returns:
        the parameter's value
      • set

        public void set​(java.lang.String name,
                        java.lang.String value)
        Set the value to be associated with the given name, replacing any previous association.
        Parameters:
        name - the parameter name
        value - the parameter's value
      • remove

        public void remove​(java.lang.String name)
        Remove any value associated with the given name.
        Parameters:
        name - the parameter name
      • getNames

        public java.util.Enumeration<java.lang.String> getNames()
        Retrieve an enumeration of all the names in this list.
        Returns:
        an enumeration of all parameter names
      • toString

        public java.lang.String toString()
        Return a string representation of this object.
        Overrides:
        toString in class java.lang.Object
      • isTokenChar

        private static boolean isTokenChar​(char c)
        Determine whether or not a given character belongs to a legal token.
      • skipWhiteSpace

        private static int skipWhiteSpace​(java.lang.String rawdata,
                                          int i)
        return the index of the first non white space character in rawdata at or after index i.
      • quote

        private static java.lang.String quote​(java.lang.String value)
        A routine that knows how and when to quote and escape the given value.
      • unquote

        private static java.lang.String unquote​(java.lang.String value)
        A routine that knows how to strip the quotes and escape sequences from the given value.