- java.lang.Object
-
- org.nibor.autolink.LinkExtractor
-
public class LinkExtractor extends Object
Extracts links from input.Create and configure an extractor using
builder()
, then callextractLinks(java.lang.CharSequence)
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LinkExtractor.Builder
Builder for configuring link extractor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LinkExtractor.Builder
builder()
Iterable<LinkSpan>
extractLinks(CharSequence input)
Extract the links from the input text.Iterable<Span>
extractSpans(CharSequence input)
Extract spans from the input text.
-
-
-
Method Detail
-
builder
public static LinkExtractor.Builder builder()
-
extractLinks
public Iterable<LinkSpan> extractLinks(CharSequence input)
Extract the links from the input text. Can be called multiple times with different inputs (thread-safe).- Parameters:
input
- the input text, must not be null- Returns:
- a lazy iterable for the links in order that they appear in the input, never null
- See Also:
extractSpans to also get spans for the plain text pieces of the input
-
extractSpans
public Iterable<Span> extractSpans(CharSequence input)
Extract spans from the input text. A span is a substring of the input and represents either a link (seeLinkSpan
) or plain text outside a link.Using this is more convenient than
extractLinks(java.lang.CharSequence)
if you want to transform the whole input text to a different format.- Parameters:
input
- the input text, must not be null- Returns:
- a lazy iterable for the spans in order that they appear in the input, never null
-
-