Top Description Fields Constructors Methods
net.fortuna.ical4j.model

public Class PropertyList

extends Object
implements ContentCollection<Property>, Comparable<PropertyList>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable, net.fortuna.ical4j.model.ContentCollection, java.io.Serializable
Imports
org.jetbrains.annotations.NotNull, java.util.*, java.util.function.Predicate, java.util.stream.Collectors

$Id$ [Apr 5, 2004] Accessor implementation for a list of iCalendar properties.
Author
Ben Fortuna

Field Summary

Modifier and TypeField and Description
private final List<Property>

Constructor Summary

AccessConstructor and Description
public
PropertyList()

Default constructor.

public
PropertyList(@NotNull List<Property>
a property list
properties
)

Creates an unmodifiable copy of the specified property list.

Method Summary

Modifier and TypeMethod and Description
public ContentCollection<Property>
public ContentCollection<Property>
public int
compareTo(PropertyList
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public List<Property>
public final List<Property>

Returns:

a property list
getProperties
(final String
name of properties to return
name
)

Returns a list of properties with the specified name.

public final <T extends Property> Optional<T>

Returns:

a property or null if no matching property found
getProperty
(final String
name of property to return
aName
)

Returns the first property of specified name.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public ContentCollection<Property>
public ContentCollection<Property>
public ContentCollection<Property>
public ContentCollection<Property>
public final String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

propertiesback to summary
private final List<Property> properties

Constructor Detail

PropertyListback to summary
public PropertyList()

Default constructor.

PropertyListback to summary
public PropertyList(@NotNull List<Property> properties)

Creates an unmodifiable copy of the specified property list.

Parameters
properties:@NotNull List<Property>

a property list

Method Detail

addback to summary
public ContentCollection<Property> add(@NotNull Property content)

Implements net.fortuna.ical4j.model.ContentCollection.add.

Annotations
@Override
addAllback to summary
public ContentCollection<Property> addAll(@NotNull Collection<Property> content)

Implements net.fortuna.ical4j.model.ContentCollection.addAll.

Annotations
@Override
compareToback to summary
public int compareTo(PropertyList o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:PropertyList

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAllback to summary
public List<Property> getAll()

Implements net.fortuna.ical4j.model.ContentCollection.getAll.

Annotations
@Override
getPropertiesback to summary
public final List<Property> getProperties(final String name)

Returns a list of properties with the specified name.

Parameters
name:String

name of properties to return

Returns:List<Property>

a property list

Annotations
@Deprecated
getPropertyback to summary
public final <T extends Property> Optional<T> getProperty(final String aName)

Returns the first property of specified name.

Parameters
aName:String

name of property to return

Returns:Optional<T>

a property or null if no matching property found

Annotations
@Deprecated
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
removeback to summary
public ContentCollection<Property> remove(Property content)

Implements net.fortuna.ical4j.model.ContentCollection.remove.

Annotations
@Override
removeAllback to summary
public ContentCollection<Property> removeAll(String... name)

Implements net.fortuna.ical4j.model.ContentCollection.removeAll.

Annotations
@Override
removeIfback to summary
public ContentCollection<Property> removeIf(Predicate<Property> filter)

Implements net.fortuna.ical4j.model.ContentCollection.removeIf.

Annotations
@Override
replaceback to summary
public ContentCollection<Property> replace(@NotNull Property content)

Implements net.fortuna.ical4j.model.ContentCollection.replace.

Annotations
@Override
toStringback to summary
public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override