ical4j 4.1.1 · net.fortuna.ical4j.model.TemporalAmountAdapter

Modifier and Type	Field and Description
private final TemporalAmount	duration

Access	Constructor and Description
public	TemporalAmountAdapter(TemporalAmount duration)

Method Summary

Modifier and Type	Method and Description
public static TemporalAmountAdapter	between(Temporal t1, Temporal t2)
private String	Returns: a string representation of the duration that is compliant with the RFC5545 specification. durationToString(Duration a duration instance duration, Temporal seed) As the `Duration` implementation doesn't support string representation in days (to avoid confusion with `Period`), we need to generate a string that does support days.
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 static TemporalAmountAdapter	from(Temporal start, Temporal end)
public static TemporalAmountAdapter	from(LocalDate start, LocalDate end)
public static TemporalAmountAdapter	from(Dur dur) References Deprecated `Dur` is deprecated or references (maybe indirectly) at least one deprecated element.
public static TemporalAmountAdapter	fromDateRange(Date start, Date end)
public TemporalAmount	getDuration()
public final Date	Returns: the end of the duration as a date getTime(final Date the date to start the duration start) Deprecated use `getDuration().addTo(start)`, where start is a `Temporal` Returns a date representing the end of this duration from the specified start date.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static TemporalAmountAdapter	parse(String value)
public static TemporalAmountAdapter	parse(String value, boolean lenient)
private String	Returns: a string representation of the period that is compliant with the RFC5545 specification. periodToString(Period a period instance period, Temporal seed) As the `Period` implementation doesn't support string representation in weeks, but does support years and months, we need to generate a string that converts years, months and days to weeks.
public Duration	toDuration()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	toString(Temporal seed)

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

duration	back to summary
private final TemporalAmount duration

TemporalAmountAdapter	back to summary
public TemporalAmountAdapter(TemporalAmount duration)

Method Detail

between	back to summary
public static TemporalAmountAdapter between(Temporal t1, Temporal t2)

durationToString back to summary

durationToString	back to summary
private String durationToString(Duration duration, Temporal seed) As the `Duration` implementation doesn't support string representation in days (to avoid confusion with `Period`), we need to generate a string that does support days. Parameters duration:Duration a duration instance Returns:String a string representation of the duration that is compliant with the RFC5545 specification.

private String durationToString(Duration duration, Temporal seed)

As the Duration implementation doesn't support string representation in days (to avoid confusion with Period), we need to generate a string that does support days.

Parameters

duration:Duration: a duration instance

Returns:String

a string representation of the duration that is compliant with the RFC5545 specification.

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

from	back to summary
public static TemporalAmountAdapter from(Temporal start, Temporal end)

from	back to summary
public static TemporalAmountAdapter from(LocalDate start, LocalDate end)

from	back to summary
public static TemporalAmountAdapter from(Dur dur) References Deprecated `Dur` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Annotations @SuppressWarnings:deprecation

fromDateRange	back to summary
public static TemporalAmountAdapter fromDateRange(Date start, Date end)

getDuration	back to summary
public TemporalAmount getDuration()

getTime back to summary

getTime	back to summary
public final Date getTime(final Date start) Deprecated use `getDuration().addTo(start)`, where start is a `Temporal` Returns a date representing the end of this duration from the specified start date. Parameters start:Date the date to start the duration Returns:Date the end of the duration as a date Annotations @Deprecated

public final Date getTime(final Date start)

Deprecated

use getDuration().addTo(start), where start is a Temporal

Returns a date representing the end of this duration from the specified start date.

Parameters

start:Date: the date to start the duration

Returns:Date

the end of the duration as a date

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

parse	back to summary
public static TemporalAmountAdapter parse(String value)

parse	back to summary
public static TemporalAmountAdapter parse(String value, boolean lenient)

periodToString back to summary

periodToString	back to summary
private String periodToString(Period period, Temporal seed) As the `Period` implementation doesn't support string representation in weeks, but does support years and months, we need to generate a string that converts years, months and days to weeks. Parameters period:Period a period instance Returns:String a string representation of the period that is compliant with the RFC5545 specification.

private String periodToString(Period period, Temporal seed)

As the Period implementation doesn't support string representation in weeks, but does support years and months, we need to generate a string that converts years, months and days to weeks.

Parameters

period:Period: a period instance

Returns:String

a string representation of the period that is compliant with the RFC5545 specification.

toDuration	back to summary
public Duration toDuration()

toString back to summary

toString	back to summary
public 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 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

toString	back to summary
public String toString(Temporal seed)

public Class TemporalAmountAdapter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail