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.

Code sample:

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

Author:

Michael Angstadt

See Also:

RFC 5545 p.93-4, RFC 2445 p.89-90, vCal 1.0 p.36

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Summary(String summary) Creates a new summary property.
Summary(Summary original) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Summary	copy() Creates a copy of this property object.
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

equals, getValue, getValue, hashCode, setValue, toStringValues, validate, valueEquals, valueHashCode

Methods inherited from class biweekly.property.ICalProperty

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Summary

public Summary(String summary)

Creates a new summary property.

Parameters:

summary - the summary

Summary

public Summary(Summary original)

Copy constructor.

Parameters:

original - the property to make a copy of

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

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.

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.

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.

Parameters:

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

See Also:

RFC 5545 p.21

copy

public Summary copy()

Description copied from class: ICalProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the ICalProperty.ICalProperty(ICalProperty) super constructor to ensure that the parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the ICalendar class's copy constructor ).

Overrides:

copy in class ICalProperty

Returns:

the copy