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. For email alarms, this is the subject line of the email.

Author:

Michael Angstadt

See Also:

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, getCommonName, getDirectoryEntry, getFormatType, getParameter, getParameters, getParameters, getSentBy, getTimezoneId, removeParameter, setCommonName, setDirectoryEntry, setFormatType, setParameter, setParameter, setParameters, setSentBy, setTimezone, setTimezoneId, 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.

Overrides:

getAltRepresentation in class ICalProperty

Returns:

the URI or null if not set

See Also:

RFC 5545 p.14-5

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.

Overrides:

setAltRepresentation in class ICalProperty

Parameters:

uri - the URI or null to remove

See Also:

RFC 5545 p.14-5

getLanguage

public String getLanguage()

Description copied from class: ICalProperty

Gets the language that the property value is written in.

Overrides:

getLanguage in class ICalProperty

Returns:

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

See Also:

RFC 5545 p.21

setLanguage

public void setLanguage(String language)

Description copied from class: ICalProperty

Sets the language that the property value is written in.

Overrides:

setLanguage in class ICalProperty

Parameters:

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

See Also:

RFC 5545 p.21