Modifier and Type	Class and Description
public static class	LinkExtractor.Builder Builder for configuring link extractor.
private class	LinkExtractor.LinkIterator
private class	LinkExtractor.SpanIterator

Modifier and Type	Field and Description
private final Scanner	emailScanner
private final Scanner	urlScanner
private final Scanner	wwwScanner

Access	Constructor and Description
private	LinkExtractor(UrlScanner urlScanner, WwwScanner wwwScanner, EmailScanner emailScanner)

Method Summary

Modifier and Type	Method and Description
public static LinkExtractor.Builder	builder()
public Iterable<LinkSpan>	Returns: a lazy iterable for the links in order that they appear in the input, never null extractLinks(final CharSequence the input text, must not be null input) Extract the links from the input text.
public Iterable<Span>	Returns: a lazy iterable for the spans in order that they appear in the input, never null extractSpans(final CharSequence the input text, must not be null input) Extract spans from the input text.
private Scanner	trigger(char c)

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

Field Detail

emailScanner	back to summary
private final Scanner emailScanner

urlScanner	back to summary
private final Scanner urlScanner

wwwScanner	back to summary
private final Scanner wwwScanner

Constructor Detail

LinkExtractor	back to summary
private LinkExtractor(UrlScanner urlScanner, WwwScanner wwwScanner, EmailScanner emailScanner)

Method Detail

builder	back to summary
public static LinkExtractor.Builder builder()

extractLinks back to summary

extractLinks	back to summary
public Iterable<LinkSpan> extractLinks(final CharSequence input) Extract the links from the input text. Can be called multiple times with different inputs (thread-safe). Parameters input:CharSequence the input text, must not be null Returns:Iterable<LinkSpan> 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`

public Iterable<LinkSpan> extractLinks(final CharSequence input)

Extract the links from the input text. Can be called multiple times with different inputs (thread-safe).

Parameters

input:CharSequence: the input text, must not be null

Returns:Iterable<LinkSpan>

a lazy iterable for the links in order that they appear in the input, never null

extractSpans back to summary

extractSpans	back to summary
public Iterable<Span> extractSpans(final CharSequence input) Extract spans from the input text. A span is a substring of the input and represents either a link (see `LinkSpan`) or plain text outside a link. Using this is more convenient than `extractLinks` if you want to transform the whole input text to a different format. Parameters input:CharSequence the input text, must not be null Returns:Iterable<Span> a lazy iterable for the spans in order that they appear in the input, never null

public Iterable<Span> extractSpans(final CharSequence input)

Extract spans from the input text. A span is a substring of the input and represents either a link (see LinkSpan) or plain text outside a link.

Using this is more convenient than extractLinks if you want to transform the whole input text to a different format.

Parameters

input:CharSequence: the input text, must not be null

Returns:Iterable<Span>

a lazy iterable for the spans in order that they appear in the input, never null

trigger	back to summary
private Scanner trigger(char c)

org.nibor.autolink back to summary

public Class LinkExtractor.Builder

Class Inheritance

extends Object

java.lang.Object
org.nibor.autolink.LinkExtractor.Builder

Builder for configuring link extractor.

Field Summary

Modifier and Type	Field and Description
private boolean	emailDomainMustHaveDot
private Set<LinkType>	linkTypes

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public LinkExtractor	Returns: the configured link extractor build()
public LinkExtractor.Builder	Returns: this builder emailDomainMustHaveDot(boolean true if the domain in an email address is required to have more than one part, false if it can also just have single part (e.g. foo@com); true by default emailDomainMustHaveDot)
public LinkExtractor.Builder	Returns: this builder linkTypes(Set<LinkType> the link types that should be extracted (by default, all types are extracted) linkTypes)

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

Field Detail

emailDomainMustHaveDot	back to summary
private boolean emailDomainMustHaveDot

linkTypes	back to summary
private Set<LinkType> linkTypes

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

build	back to summary
public LinkExtractor build() Returns:LinkExtractor the configured link extractor

emailDomainMustHaveDot	back to summary
public LinkExtractor.Builder emailDomainMustHaveDot(boolean emailDomainMustHaveDot) Parameters emailDomainMustHaveDot:boolean true if the domain in an email address is required to have more than one part, false if it can also just have single part (e.g. foo@com); true by default Returns:LinkExtractor.Builder this builder

linkTypes	back to summary
public LinkExtractor.Builder linkTypes(Set<LinkType> linkTypes) Parameters linkTypes:Set<LinkType> the link types that should be extracted (by default, all types are extracted) Returns:LinkExtractor.Builder this builder

org.nibor.autolink back to summary

private Class LinkExtractor.LinkIterator

Class Inheritance

extends Object
implements Iterator<LinkSpan>

java.lang.Object
org.nibor.autolink.LinkExtractor.LinkIterator

All Implemented Interfaces

java.util.Iterator

Field Summary

Modifier and Type	Field and Description
private int	index
private final CharSequence	input
private LinkSpan	next
private int	rewindIndex

Constructor Summary

Access	Constructor and Description
public	LinkIterator(CharSequence input)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public LinkSpan	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).
private void	setNext()

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

Field Detail

index	back to summary
private int index

input	back to summary
private final CharSequence input

next	back to summary
private LinkSpan next

rewindIndex	back to summary
private int rewindIndex

Constructor Detail

LinkIterator	back to summary
public LinkIterator(CharSequence input)

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next	back to summary
public LinkSpan next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:LinkSpan the next element in the iteration Annotations @Override

back to summary

public LinkSpan next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:LinkSpan

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

setNext	back to summary
private void setNext()

org.nibor.autolink back to summary

private Class LinkExtractor.SpanIterator

Class Inheritance

extends Object
implements Iterator<Span>

java.lang.Object
org.nibor.autolink.LinkExtractor.SpanIterator

All Implemented Interfaces

java.util.Iterator

Field Summary

Modifier and Type	Field and Description
private int	index
private final CharSequence	input
private final LinkExtractor.LinkIterator	linkIterator
private LinkSpan	nextLink

Constructor Summary

Access	Constructor and Description
public	SpanIterator(CharSequence input, LinkExtractor.LinkIterator linkIterator)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Span	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
private Span	nextTextSpan(int endIndex)
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

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

Field Detail

index	back to summary
private int index

input	back to summary
private final CharSequence input

linkIterator	back to summary
private final LinkExtractor.LinkIterator linkIterator

nextLink	back to summary
private LinkSpan nextLink

Constructor Detail

SpanIterator	back to summary
public SpanIterator(CharSequence input, LinkExtractor.LinkIterator linkIterator)

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next	back to summary
public Span next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:Span the next element in the iteration Annotations @Override

back to summary

public Span next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Span

the next element in the iteration

Annotations

@Override

nextTextSpan	back to summary
private Span nextTextSpan(int endIndex)

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

public Class LinkExtractor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class LinkExtractor.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class LinkExtractor.LinkIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class LinkExtractor.SpanIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail