ical4j 4.1.1 · net.fortuna.ical4j.model.ParameterList

Modifier and Type	Field and Description
private final List<Parameter>	parameters

Access	Constructor and Description
public	ParameterList() Default constructor.
public	ParameterList(@NotNull List<Parameter> a parameter list to copy parameters from list) Creates an unmodifiable copy of the specified parameter list.

Method Summary

Modifier and Type	Method and Description
public ContentCollection<Parameter>	add(Parameter content) Implements net.fortuna.ical4j.model.ContentCollection.add.
public ContentCollection<Parameter>	addAll(@NotNull Collection<Parameter> content) Implements net.fortuna.ical4j.model.ContentCollection.addAll.
public int	compareTo(ParameterList 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<Parameter>	getAll() Implements net.fortuna.ical4j.model.ContentCollection.getAll.
public final <T extends Parameter> Optional<T>	Returns: the first matching parameter or null if no matching parameters getParameter(final String name of the parameter aName) Deprecated use `ParameterList#getFirst(String)` Returns the first parameter with the specified name.
public final ParameterList	Returns: a parameter list getParameters(final String name of parameters to return name) Deprecated use `ParameterList#get(String...)` Returns a list of parameters with the specified name.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public ContentCollection<Parameter>	remove(Parameter content) Implements net.fortuna.ical4j.model.ContentCollection.remove.
public ContentCollection<Parameter>	removeAll(String... name) Implements net.fortuna.ical4j.model.ContentCollection.removeAll.
public ContentCollection<Parameter>	removeIf(Predicate<Parameter> filter) Implements net.fortuna.ical4j.model.ContentCollection.removeIf.
public ContentCollection<Parameter>	replace(@NotNull Parameter content) Implements net.fortuna.ical4j.model.ContentCollection.replace.
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

parameters	back to summary
private final List<Parameter> parameters

ParameterList	back to summary
public ParameterList() Default constructor. Creates an empty parameter list.

ParameterList	back to summary
public ParameterList(@NotNull List<Parameter> list) Creates an unmodifiable copy of the specified parameter list. Parameters list:@NotNull List<Parameter> a parameter list to copy parameters from

Method Detail

add	back to summary
public ContentCollection<Parameter> add(Parameter content) Implements net.fortuna.ical4j.model.ContentCollection.add. Annotations @Override

add

back to summary

public ContentCollection<Parameter> add(Parameter content)

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

Annotations

@Override

addAll	back to summary
public ContentCollection<Parameter> addAll(@NotNull Collection<Parameter> content) Implements net.fortuna.ical4j.model.ContentCollection.addAll. Annotations @Override

addAll

back to summary

public ContentCollection<Parameter> addAll(@NotNull Collection<Parameter> content)

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

Annotations

@Override

compareTo back to summary

compareTo	back to summary
public int compareTo(ParameterList 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:ParameterList 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

public int compareTo(ParameterList 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:ParameterList: 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

equals back to summary

equals	back 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

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

getAll	back to summary
public List<Parameter> getAll() Implements net.fortuna.ical4j.model.ContentCollection.getAll. Annotations @Override

getAll

back to summary

public List<Parameter> getAll()

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

Annotations

@Override

getParameter back to summary

getParameter	back to summary
public final <T extends Parameter> Optional<T> getParameter(final String aName) Deprecated use `ParameterList#getFirst(String)` Returns the first parameter with the specified name. Parameters aName:String name of the parameter Returns:Optional<T> the first matching parameter or null if no matching parameters Annotations @Deprecated

public final <T extends Parameter> Optional<T> getParameter(final String aName)

Deprecated

use ParameterList#getFirst(String)

Returns the first parameter with the specified name.

Parameters

aName:String: name of the parameter

Returns:Optional<T>

the first matching parameter or null if no matching parameters

Annotations

@Deprecated

getParameters back to summary

getParameters	back to summary
public final ParameterList getParameters(final String name) Deprecated use `ParameterList#get(String...)` Returns a list of parameters with the specified name. Parameters name:String name of parameters to return Returns:ParameterList a parameter list Annotations @Deprecated

public final ParameterList getParameters(final String name)

Deprecated

use ParameterList#get(String...)

Returns a list of parameters with the specified name.

Parameters

name:String: name of parameters to return

Returns:ParameterList

a parameter list

Annotations

@Deprecated

hashCode back to summary

hashCode	back 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

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

remove	back to summary
public ContentCollection<Parameter> remove(Parameter content) Implements net.fortuna.ical4j.model.ContentCollection.remove. Annotations @Override

remove

back to summary

public ContentCollection<Parameter> remove(Parameter content)

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

Annotations

@Override

removeAll	back to summary
public ContentCollection<Parameter> removeAll(String... name) Implements net.fortuna.ical4j.model.ContentCollection.removeAll. Annotations @Override

removeAll

back to summary

public ContentCollection<Parameter> removeAll(String... name)

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

Annotations

@Override

removeIf	back to summary
public ContentCollection<Parameter> removeIf(Predicate<Parameter> filter) Implements net.fortuna.ical4j.model.ContentCollection.removeIf. Annotations @Override

removeIf

back to summary

public ContentCollection<Parameter> removeIf(Predicate<Parameter> filter)

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

Annotations

@Override

replace	back to summary
public ContentCollection<Parameter> replace(@NotNull Parameter content) Implements net.fortuna.ical4j.model.ContentCollection.replace. Annotations @Override

replace

back to summary

public ContentCollection<Parameter> replace(@NotNull Parameter content)

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

Annotations

@Override

toString back to summary

toString	back 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

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

public Class ParameterList

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail