jfxtras.icalendarfx.properties.component.descriptive.Description Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jfxtras-all Show documentation
Miscellaneous components for JavaFX
The newest version!
package jfxtras.icalendarfx.properties.component.descriptive;

import jfxtras.icalendarfx.components.VAlarm;
import jfxtras.icalendarfx.components.VEvent;
import jfxtras.icalendarfx.components.VJournal;
import jfxtras.icalendarfx.components.VTodo;
import jfxtras.icalendarfx.parameters.AlternateText;
import jfxtras.icalendarfx.parameters.Language;
import jfxtras.icalendarfx.parameters.NonStandardParameter;
import jfxtras.icalendarfx.properties.PropBaseAltText;
import jfxtras.icalendarfx.properties.ValueType;
import jfxtras.icalendarfx.properties.component.descriptive.Description;
import jfxtras.icalendarfx.properties.component.descriptive.Summary;

/**
 * 3.8.1.5.  Description

   Property Name:  DESCRIPTION

   Purpose:  This property provides a more complete description of the
      calendar component than that provided by the {@link Summary SUMMARY} property.

   Value Type:  {@link ValueType.TEXT TEXT}

   Property Parameters:  IANA, {@link NonStandardParameter non-standard},
      {@link AlternateText alternate text representation}, and {@link Language language property} parameters can be specified
      on this property.

   Conformance:  The property can be specified in the {@link VEvent VEVENT}, {@link VTodo VTODO},
      {@link VJournal VJOURNAL}, or {@link VAlarm VALARM} calendar components.  The property can be
      specified multiple times only within a {@link VJournal VJOURNAL} calendar
      component.

   Description:  This property is used in the {@link VEvent VEVENT} and {@link VTodo VTODO} to
      capture lengthy textual descriptions associated with the activity.

      This property is used in the {@link VJournal VJOURNAL} calendar component to
      capture one or more textual journal entries.

      This property is used in the {@link VAlarm VALARM} calendar component to
      capture the display text for a DISPLAY category of alarm, and to
      capture the body text for an EMAIL category of alarm.

  Format Definition:  This property is defined by the following notation:
  
  description
    
    "DESCRIPTION" descparam ":" text CRLF
    
  descparam
    
    The following are OPTIONAL, but MUST NOT occur more than once.
      
      ";" {@link AlternateText Alternate text representation}
      
";" {@link Language Language for text}
      
    
The following are OPTIONAL, and MAY occur more than once.
    
      other-param
        
        ";" {@link NonStandardParameter}
        
";" {@link IANAParameter}
        
    
  
  Example:  The following is an example of this property with formatted
      line breaks in the property value:
  

  DESCRIPTION:Meeting to provide technical review for "Phoenix"

         design.\nHappy Face Conference Room. Phoenix design team

         MUST attend this meeting.\nRSVP to team leader.
  
  
  RFC 5545                       iCalendar                  September 2009
 */
public class Description extends PropBaseAltText
{
    /** Create deep copy of source Description */
    public Description(Description source)
    {
        super(source);
    }
    
    /** Create Description with property value set to input parameter */
    public Description(String value)
    {
        super();
        setValue(value);
    }

    /** Create default Description with no value set */
    public Description()
    {
        super();
    }
    
    /** Create new Description by parsing unfolded calendar content */
    public static Description parse(String unfoldedContent)
    {
    	return Description.parse(new Description(), unfoldedContent);
    }
}