jfxtras.icalendarfx.properties.component.descriptive.Summary 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.component.descriptive.Summary;

/**
3.8.1.12.  Summary

   Property Name:  SUMMARY

   Purpose:  This property defines a short summary or subject for the
      calendar component.

   Value Type:  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 {@link VEvent VEVENT}, {@link VTodo VTODO},
    {@link VJournal VJOURNAL}, or {@link VAlarm VALARM} calendar components.

   Description:  This property is used in the {@link VEvent VEVENT}, {@link VTodo VTODO} AND
    {@link VJournal VJOURNAL} calendar components to capture a short, one-line
      summary about the activity or journal entry.

      This property is used in the {@link VAlarm VALARM} calendar component to
      capture the subject of an EMAIL category of alarm.

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

  summary
    
    "SUMMARY" summparam ":" text CRLF
    
  
summparam
    
    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:
  

  SUMMARY:Department Party
  
  
  RFC 5545                       iCalendar                  September 2009
 */
public class Summary extends PropBaseAltText
{	
	/** Create deep copy of source Summary */
    public Summary(Summary source)
    {
        super(source);
    }
    
    /** Create Summary with property value set to parameter value*/
    public Summary(String value)
    {
        super();
        setValue(value);
    }

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