biweekly.property
Class Summary

java.lang.Object
  biweekly.property.ICalProperty
      biweekly.property.ValuedProperty<String>
          biweekly.property.TextProperty
              biweekly.property.Summary

public class Summary
extends TextProperty

Defines a short, one line summary of the component that this property belongs to. The summary should be a more concise version of the text provided by the Description property.

Examples:

 Summary summary = new Summary("summary text");
 
 VEvent event = ...;
 event.setSummary("summary text");
 

Author:

Michael Angstadt

Specification Reference:

RFC 5545 p.93-4

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Summary(String summary)
Creates a new summary property.

Method Summary

String	getAltRepresentation() Gets a URI pointing to additional information about the entity represented by the property.
String	getLanguage() Gets the language that the property value is written in.
void	setAltRepresentation(String uri) Sets a URI pointing to additional information about the entity represented by the property.
void	setLanguage(String language) Sets the language that the property value is written in.

Methods inherited from class biweekly.property.ValuedProperty

getValue, setValue, validate

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Summary

public Summary(String summary)

Creates a new summary property.

Parameters:

summary - the summary

Method Detail

getAltRepresentation

public String getAltRepresentation()

Description copied from class: ICalProperty

Gets a URI pointing to additional information about the entity represented by the property.

Returns:

the URI or null if not set

setAltRepresentation

public void setAltRepresentation(String uri)

Description copied from class: ICalProperty

Sets a URI pointing to additional information about the entity represented by the property.

Parameters:

uri - the URI or null to remove

getLanguage

public String getLanguage()

Description copied from class: ICalProperty

Gets the language that the property value is written in.

Returns:

the language (e.g. "en" for English) or null if not set

setLanguage

public void setLanguage(String language)

Description copied from class: ICalProperty

Sets the language that the property value is written in.

Parameters:

language - the language (e.g. "en" for English) or null to remove