biweekly.property

Class Transparency

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<String>

biweekly.property.TextProperty

biweekly.property.EnumProperty

biweekly.property.Transparency

public class Transparency
extends EnumProperty

Defines whether an event is visible to free/busy time searches or not. If an event does not have this property, the event should be considered opaque (visible) to searches.

Code sample (creating):

 VEvent event = new VEvent();
 
 Transparency transp = Transparency.opaque();
 event.setTransparency(transp);
 
 event.setTransparency(true); //hidden from searches
 event.setTransparency(false); //visible to searches
 

Code sample (retrieving):

 ICalendar ical = ...
 for (VEvent event : ical.getEvents()) {
   Transparency transp = event.getTransparency();
   if (transp.isOpaque()) {
     //...
   } else if (transp.isTransparent()) {
     //...
   }
 }
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.101-2, RFC 2445 p.96-7, vCal 1.0 p.36-7

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPAQUE
static String	TRANSPARENT

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Transparency(String value) Creates a new transparency property.
Transparency(Transparency original) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Transparency	copy() Creates a copy of this property object.
protected Collection<String>	getStandardValues(ICalVersion version) Gets the list of acceptable values for this property.
boolean	isOpaque() Determines if the event is visible to free/busy time searches.
boolean	isTransparent() Determines if the event is hidden from free/busy time searches.
static Transparency	opaque() Creates a property that marks the event as being visible to free/busy time searches.
static Transparency	transparent() Creates a property that marks the event as being hidden from free/busy time searches.

Methods inherited from class biweekly.property.EnumProperty

equals, getValueSupportedVersions, hashCode, is, validate

Methods inherited from class biweekly.property.ValuedProperty

getValue, getValue, setValue, toStringValues, 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

Field Detail

OPAQUE

public static final String OPAQUE

See Also:

Constant Field Values

TRANSPARENT

public static final String TRANSPARENT

See Also:

Constant Field Values

Constructor Detail

Transparency

public Transparency(String value)

Creates a new transparency property.

Parameters:

value - the value

Transparency

public Transparency(Transparency original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

opaque

public static Transparency opaque()

Creates a property that marks the event as being visible to free/busy time searches.

Returns:

the property

isOpaque

public boolean isOpaque()

Determines if the event is visible to free/busy time searches.

Returns:

true if it's visible, false if not

transparent

public static Transparency transparent()

Creates a property that marks the event as being hidden from free/busy time searches.

Returns:

the property

isTransparent

public boolean isTransparent()

Determines if the event is hidden from free/busy time searches.

Returns:

true if it's hidden, false if not

getStandardValues

protected Collection<String> getStandardValues(ICalVersion version)

Description copied from class: EnumProperty

Gets the list of acceptable values for this property.

Specified by:

getStandardValues in class EnumProperty

Parameters:

version - the version

Returns:

the list of acceptable values

copy

public Transparency 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