Skip to content

Commit

Permalink
updated javadoc links
Browse files Browse the repository at this point in the history
  • Loading branch information
benfortuna committed Aug 17, 2024
1 parent 57e163c commit ab04473
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ To increase interoperability with other CUAs a number of _Compatibility Hints_ a

## Enabling Compatibility Hints programmatically

Compatibility Hints can be enabled and disabled by calling the static method [CompatibilityHints.setHintEnabled()](http://ical4j.github.io/docs/ical4j/api/3.0.19/net/fortuna/ical4j/util/CompatibilityHints.html#setHintEnabled(java.lang.String,%20boolean)). For example:
Compatibility Hints can be enabled and disabled by calling the static method [CompatibilityHints.setHintEnabled()](http://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/util/CompatibilityHints.html#setHintEnabled(java.lang.String,%20boolean)). For example:

```java
CompatibilityHints.setHintEnabled(KEY_RELAXED_UNFOLDING, true);
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This page provides examples of using iCal4j to filter iCal4j objects.

## Filtering events

The correct way to filter events according to the spec (RFC2445) would be to construct a VFREEBUSY request that represents the properties of events that you are interested in. You would then pass this request as an argument to the constructor of a new VFREEBUSY, along with the list of components (events) you want to inspect to derive a VFREEBUSY instance that represents the consumed/free time based on the specified events (see the [API Documentation](http://ical4j.github.io/docs/ical4j/api/3.0.19/net/fortuna/ical4j/model/component/VFreeBusy.html) for more information).
The correct way to filter events according to the spec (RFC2445) would be to construct a VFREEBUSY request that represents the properties of events that you are interested in. You would then pass this request as an argument to the constructor of a new VFREEBUSY, along with the list of components (events) you want to inspect to derive a VFREEBUSY instance that represents the consumed/free time based on the specified events (see the [API Documentation](http://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/model/component/VFreeBusy.html) for more information).

If instead you would like to identify specific events occurring within a time frame, you can use iCal4j filters to filter components within a specified period. For example, to filter a list of events only occurring today you might do the following:

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The following table provides an overview of the currently active projects in iCa
- For a concise description of the goals and directions of iCal4j please
take a look at the [open issues](https://github.com/ical4j/ical4j/issues).

- In this guide You will find [examples](https://www.ical4j.org/examples/) of how to use iCal4j, as well as throughout the [API documentation](https://ical4j.github.io/docs/ical4j/api).
- In this guide You will find [examples](https://www.ical4j.org/examples/) of how to use iCal4j, as well as throughout the [API documentation](https://javadoc.io/doc/org.mnode.ical4j/ical4j/).

- Detailed descriptions of changes included in each release may be found
in the [CHANGELOG](https://ical4j.github.io/docs/ical4j/release-notes).
Expand Down
8 changes: 4 additions & 4 deletions docs/parser.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ The iCal4j parsing functionality is designed to allow the use of alternate parse

![parsing.mmd.svg](images/parsing.mmd.svg)

### [net.fortuna.ical4j.data.CalendarParser](http://ical4j.github.io/docs/ical4j/api/3.0.19/net/fortuna/ical4j/data/CalendarParser.html)
### [net.fortuna.ical4j.data.CalendarParser](http://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/data/CalendarParser.html)

The CalendarParser interface defines two methods that implementors must provide implementations for. The first method parses data from a java.io.InputStream, whilst the second reads from a java.io.Reader. Both methods must notify the specified ContentHandler by calling the appropriate methods on parse events. The default parser implementation used by iCal4j is the [net.fortuna.ical4j.data.CalendarParserImpl](http://ical4j.github.io/docs/ical4j/api/3.0.19/net/fortuna/ical4j/data/CalendarParserImpl.html).
The CalendarParser interface defines two methods that implementors must provide implementations for. The first method parses data from a java.io.InputStream, whilst the second reads from a java.io.Reader. Both methods must notify the specified ContentHandler by calling the appropriate methods on parse events. The default parser implementation used by iCal4j is the [net.fortuna.ical4j.data.CalendarParserImpl](http://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/data/CalendarParserImpl.html).

### [net.fortuna.ical4j.data.ContentHandler](http://ical4j.github.io/docs/ical4j/api/3.0.19/net/fortuna/ical4j/data/ContentHandler.html)
### [net.fortuna.ical4j.data.ContentHandler](http://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/data/ContentHandler.html)

Implementors of the ContentHandler interface typically use the parse event notification methods to build a calendar representation (i.e. an object model). The default ContentHandler implementation for iCal4j is the CalendarBuilder.

### [net.fortuna.ical4j.data.CalendarBuilder](http://ical4j.github.io/docs/ical4j/api/3.0.19/net/fortuna/ical4j/data/CalendarBuilder.html)
### [net.fortuna.ical4j.data.CalendarBuilder](http://javadoc.io/doc/org.mnode.ical4j/ical4j/latest/ical4j.core/net/fortuna/ical4j/data/CalendarBuilder.html)

CalendarBuilder is the default starting point for parsing an iCalendar data stream into an iCal4j object model. A CalendarBuilder instance requires both a CalendarParser (for parsing the data stream) and TimeZoneRegistry instance, however contructors are available that will use default implementations.

0 comments on commit ab04473

Please sign in to comment.