Status (biweekly 0.6.8 API)

java.lang.Object
- biweekly.property.ICalProperty
- - biweekly.property.ValuedProperty<String>
  - - biweekly.property.TextProperty
    - - biweekly.property.EnumProperty
      - biweekly.property.Status

public class Status
extends EnumProperty

Defines the status of the component that this property belongs to, such as a to-do task being "completed".

Code sample (creating):

 VTodo todo = new VTodo();
 
 Status status = Status.completed();
 todo.setStatus(status);

Code sample (retrieving):

 ICalendar ical = ...
 for (VTodo todo : ical.getTodos()) {
   Status status = todo.getStatus();
   if (action.isCompleted()) {
     //...
   } else if (action.isDraft()) {
     //...
   }
   //etc.
 }

Author:: Michael Angstadt
See Also:: RFC 5545 p.92-3, RFC 2445 p.88-9, vCal 1.0 p.35-6

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEPTED`
`static String`	`CANCELLED`
`static String`	`COMPLETED`
`static String`	`CONFIRMED`
`static String`	`DECLINED`
`static String`	`DELEGATED`
`static String`	`DRAFT`
`static String`	`FINAL`
`static String`	`IN_PROGRESS`
`static String`	`NEEDS_ACTION`
`static String`	`SENT`
`static String`	`TENTATIVE`

Fields inherited from class biweekly.property.ValuedProperty
value

Fields inherited from class biweekly.property.ICalProperty
parameters

Constructor Summary

Constructors
Constructor and Description

Status(Status original)
Copy constructor.

Status(String status)
Creates a status property.

Constructors
Constructor and Description
`Status(Status original)` Copy constructor.
`Status(String status)` Creates a status property.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Status`	`accepted()` Creates an "accepted" status property (only valid in vCal 1.0 in `VTodo` components).
`static Status`	`cancelled()` Creates a "cancelled" status property (only valid in iCalendar 2.0 in `VEvent`, `VTodo`, and `VJournal` components).
`static Status`	`completed()` Creates a "completed" status property (only valid in `VTodo` components).
`static Status`	`confirmed()` Creates a "confirmed" status property (only valid for event components).
`Status`	`copy()` Creates a copy of this property object.
`static Status`	`create(String status)`
`static Status`	`declined()` Creates a "declined" status property (only valid in vCal 1.0).
`static Status`	`delegated()` Creates a "delegated" status property (only valid in vCal 1.0).
`static Status`	`draft()` Creates a "draft" status property (only valid in iCalendar 2.0 in `VJournal` components).
`static Status`	`final_()` Creates a "final" status property (only valid in iCalendar 2.0 in `VJournal` components).
`protected Collection<String>`	`getStandardValues(ICalVersion version)` Gets the list of acceptable values for this property.
`protected Collection<ICalVersion>`	`getValueSupportedVersions()` Gets the iCalendar versions that this property's value is supported in.
`static Status`	`inProgress()` Creates a "in-progress" status property (only valid in iCalendar 2.0 in `VTodo` components).
`boolean`	`isAccepted()` Determines if the status is set to "accepted".
`boolean`	`isCancelled()` Determines if the status is set to "cancelled".
`boolean`	`isCompleted()` Determines if the status is set to "completed".
`boolean`	`isConfirmed()` Determines if the status is set to "confirmed".
`boolean`	`isDeclined()` Determines if the status is set to "declined".
`boolean`	`isDelegated()` Determines if the status is set to "delegated".
`boolean`	`isDraft()` Determines if the status is set to "draft".
`boolean`	`isFinal()` Determines if the status is set to "final".
`boolean`	`isInProgress()` Determines if the status is set to "in-progress".
`boolean`	`isNeedsAction()` Determines if the status is set to "needs-action".
`boolean`	`isSent()` Determines if the status is set to "sent".
`boolean`	`isTentative()` Determines if the status is set to "tentative".
`static Status`	`needsAction()` Creates a "needs-action" status property.
`static Status`	`sent()` Creates a "sent" status property (only valid in vCal 1.0).
`static Status`	`tentative()` Creates a "tentative" status property (only valid for event components).

Methods inherited from class biweekly.property.EnumProperty
equals, 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
  - CANCELLED
```
public static final String CANCELLED
```
    See Also:
    
    Constant Field Values
  - DRAFT
```
public static final String DRAFT
```
    See Also:
    
    Constant Field Values
  - FINAL
```
public static final String FINAL
```
    See Also:
    
    Constant Field Values
  - IN_PROGRESS
```
public static final String IN_PROGRESS
```
    See Also:
    
    Constant Field Values
  - ACCEPTED
```
public static final String ACCEPTED
```
    See Also:
    
    Constant Field Values
  - DECLINED
```
public static final String DECLINED
```
    See Also:
    
    Constant Field Values
  - DELEGATED
```
public static final String DELEGATED
```
    See Also:
    
    Constant Field Values
  - SENT
```
public static final String SENT
```
    See Also:
    
    Constant Field Values
  - COMPLETED
```
public static final String COMPLETED
```
    See Also:
    
    Constant Field Values
  - CONFIRMED
```
public static final String CONFIRMED
```
    See Also:
    
    Constant Field Values
  - NEEDS_ACTION
```
public static final String NEEDS_ACTION
```
    See Also:
    
    Constant Field Values
  - TENTATIVE
```
public static final String TENTATIVE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Status
```
public Status(String status)
```
    Creates a status property. Use of this constructor is discouraged and may put the property in an invalid state. Use one of the static factory methods instead.
    
    Parameters:
    
    status - the status (e.g. "TENTATIVE")
  - Status
```
public Status(Status original)
```
    Copy constructor.
    
    Parameters:
    
    original - the property to make a copy of
- Method Detail
  - tentative
```
public static Status tentative()
```
    Creates a "tentative" status property (only valid for event components).
    
    Returns:
    
    the property
  - isTentative
```
public boolean isTentative()
```
    Determines if the status is set to "tentative".
    
    Returns:
    
    true if it is, false if not
  - confirmed
```
public static Status confirmed()
```
    Creates a "confirmed" status property (only valid for event components).
    
    Returns:
    
    the property
  - isConfirmed
```
public boolean isConfirmed()
```
    Determines if the status is set to "confirmed".
    
    Returns:
    
    true if it is, false if not
  - cancelled
```
public static Status cancelled()
```
    Creates a "cancelled" status property (only valid in iCalendar 2.0 in VEvent, VTodo, and VJournal components).
    
    Returns:
    
    the property
  - isCancelled
```
public boolean isCancelled()
```
    Determines if the status is set to "cancelled".
    
    Returns:
    
    true if it is, false if not
  - needsAction
```
public static Status needsAction()
```
    Creates a "needs-action" status property.
    
    Returns:
    
    the property
  - isNeedsAction
```
public boolean isNeedsAction()
```
    Determines if the status is set to "needs-action".
    
    Returns:
    
    true if it is, false if not
  - completed
```
public static Status completed()
```
    Creates a "completed" status property (only valid in VTodo components).
    
    Returns:
    
    the property
  - isCompleted
```
public boolean isCompleted()
```
    Determines if the status is set to "completed".
    
    Returns:
    
    true if it is, false if not
  - inProgress
```
public static Status inProgress()
```
    Creates a "in-progress" status property (only valid in iCalendar 2.0 in VTodo components).
    
    Returns:
    
    the property
  - isInProgress
```
public boolean isInProgress()
```
    Determines if the status is set to "in-progress".
    
    Returns:
    
    true if it is, false if not
  - draft
```
public static Status draft()
```
    Creates a "draft" status property (only valid in iCalendar 2.0 in VJournal components).
    
    Returns:
    
    the property
  - isDraft
```
public boolean isDraft()
```
    Determines if the status is set to "draft".
    
    Returns:
    
    true if it is, false if not
  - final_
```
public static Status final_()
```
    Creates a "final" status property (only valid in iCalendar 2.0 in VJournal components).
    
    Returns:
    
    the property
  - isFinal
```
public boolean isFinal()
```
    Determines if the status is set to "final".
    
    Returns:
    
    true if it is, false if not
  - accepted
```
public static Status accepted()
```
    Creates an "accepted" status property (only valid in vCal 1.0 in VTodo components).
    
    Returns:
    
    the property
  - isAccepted
```
public boolean isAccepted()
```
    Determines if the status is set to "accepted".
    
    Returns:
    
    true if it is, false if not
  - declined
```
public static Status declined()
```
    Creates a "declined" status property (only valid in vCal 1.0).
    
    Returns:
    
    the property
  - isDeclined
```
public boolean isDeclined()
```
    Determines if the status is set to "declined".
    
    Returns:
    
    true if it is, false if not
  - delegated
```
public static Status delegated()
```
    Creates a "delegated" status property (only valid in vCal 1.0).
    
    Returns:
    
    the property
  - isDelegated
```
public boolean isDelegated()
```
    Determines if the status is set to "delegated".
    
    Returns:
    
    true if it is, false if not
  - sent
```
public static Status sent()
```
    Creates a "sent" status property (only valid in vCal 1.0).
    
    Returns:
    
    the property
  - isSent
```
public boolean isSent()
```
    Determines if the status is set to "sent".
    
    Returns:
    
    true if it is, false if not
  - create
```
public static Status create(String status)
```
  - 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
  - getValueSupportedVersions
```
protected Collection<ICalVersion> getValueSupportedVersions()
```
    Description copied from class: EnumProperty
    
    Gets the iCalendar versions that this property's value is supported in. Meant to be overridden by the child class.
    
    Overrides:
    
    getValueSupportedVersions in class EnumProperty
    
    Returns:
    
    the supported versions
  - copy
```
public Status 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

Class Status

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

Fields inherited from class biweekly.property.ICalProperty

Constructor Summary

Method Summary

Methods inherited from class biweekly.property.EnumProperty

Methods inherited from class biweekly.property.ValuedProperty

Methods inherited from class biweekly.property.ICalProperty

Methods inherited from class java.lang.Object

Field Detail

CANCELLED

DRAFT

FINAL

IN_PROGRESS

ACCEPTED

DECLINED

DELEGATED

SENT

COMPLETED

CONFIRMED

NEEDS_ACTION

TENTATIVE

Constructor Detail

Status

Status

Method Detail

tentative

isTentative

confirmed

isConfirmed

cancelled

isCancelled

needsAction

isNeedsAction

completed

isCompleted

inProgress

isInProgress

draft

isDraft

final_

isFinal

accepted

isAccepted

declined

isDeclined

delegated

isDelegated

sent

isSent

create

getStandardValues

getValueSupportedVersions

copy