jfxtras.icalendarfx.parameters.AlternateText Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfxtras-icalendarfx Show documentation
There is a newer version: 17-r1
package jfxtras.icalendarfx.parameters;

import java.net.URI;

import jfxtras.icalendarfx.parameters.AlternateText;
import jfxtras.icalendarfx.parameters.VParameterBase;
import jfxtras.icalendarfx.utilities.StringConverter;
import jfxtras.icalendarfx.utilities.StringConverters;

/**
 *  * 3.2.1.  Alternate Text Representation

   Parameter Name:  ALTREP

   Purpose:  To specify an alternate text representation for the
      property value.

   Format Definition:  This property parameter is defined by the
      following notation:

     altrepparam = "ALTREP" "=" DQUOTE uri DQUOTE

   Description:  This parameter specifies a URI that points to an
      alternate representation for a textual property value.  A property
      specifying this parameter MUST also include a value that reflects



Desruisseaux                Standards Track                    [Page 14]
 
RFC 5545                       iCalendar                  September 2009


      the default representation of the text value.  The URI parameter
      value MUST be specified in a quoted-string.

         Note: While there is no restriction imposed on the URI schemes
         allowed for this parameter, Content Identifier (CID) [RFC2392],
         HTTP [RFC2616], and HTTPS [RFC2818] are the URI schemes most
         commonly used by current implementations.

   Example:

       DESCRIPTION;ALTREP="CID:[email protected]":
        Project XYZ Review Meeting will include the following agenda
         items: (a) Market Overview\, (b) Finances\, (c) Project Man
        agement

      The "ALTREP" property parameter value might point to a "text/html"
      content portion.

       Content-Type:text/html
       Content-Id:

       
         
          
         
         
           
             Project XYZ Review Meeting will include
             the following agenda items:
             

               Market Overview
               Finances
               Project Management
             
           
         
       
  RFC 5545                       iCalendar                  September 2009
 * 
 * @author David Bal
 */
public class AlternateText extends VParameterBase
{
	private static final StringConverter CONVERTER = StringConverters.uriConverterWithQuotes();
	
    /** Create new AlternateText with property value set to input parameter */
    public AlternateText(URI value)
    {
        super(value, CONVERTER);
    }

    /** Create deep copy of source AlternateText */
    public AlternateText(AlternateText source)
    {
        super(source, CONVERTER);
    }

    /** Create default Summary with no value set */
    public AlternateText()
    {
        super(CONVERTER);
    }
    
    public static AlternateText parse(String content)
    {
    	return AlternateText.parse(new AlternateText(), content);
    }
}