Rename Link to LinkSpan

Link is a bit generic. LinkSpan better describes that it's not a link in
itself, but merely the information about the link.

Author: robinst

README.md

@@ -58,8 +58,8 @@ import org.nibor.autolink.*;
 
 String input = "wow, so example: http://test.com";
 LinkExtractor linkExtractor = LinkExtractor.builder().build();
-Iterable<Link> links = linkExtractor.extractLinks(input);
-Link link = links.iterator().next();
+Iterable<LinkSpan> links = linkExtractor.extractLinks(input);
+LinkSpan link = links.iterator().next();
 link.getType();        // LinkType.URL
 link.getBeginIndex();  // 17
 link.getEndIndex();    // 32
@@ -75,7 +75,7 @@ String input = "wow http://test.com such linked";
 LinkExtractor linkExtractor = LinkExtractor.builder()
         .linkTypes(EnumSet.of(LinkType.URL)) // limit to URLs
         .build();
-Iterable<Link> links = linkExtractor.extractLinks(input);
+Iterable<LinkSpan> links = linkExtractor.extractLinks(input);
 String result = Autolink.renderLinks(input, links, (link, sb) -> {
     sb.append("<a href=\"");
     sb.append(input, link.getBeginIndex(), link.getEndIndex());

src/main/java/org/nibor/autolink/Autolink.java

@@ -14,10 +14,10 @@ public class Autolink {
      * @param linkRenderer the link rendering function
      * @return the rendered string
      */
-    public static String renderLinks(CharSequence input, Iterable<Link> links, LinkRenderer linkRenderer) {
+    public static String renderLinks(CharSequence input, Iterable<LinkSpan> links, LinkRenderer linkRenderer) {
         StringBuilder sb = new StringBuilder(input.length() + 16);
         int lastIndex = 0;
-        for (Link link : links) {
+        for (LinkSpan link : links) {
             sb.append(input, lastIndex, link.getBeginIndex());
             linkRenderer.render(link, sb);
             lastIndex = link.getEndIndex();

src/main/java/org/nibor/autolink/LinkExtractor.java

@@ -32,10 +32,10 @@ public static Builder builder() {
      * @param input the input text, must not be {@code null}
      * @return a lazy iterable for the links in order that they appear in the input, never {@code null}
      */
-    public Iterable<Link> extractLinks(final CharSequence input) {
-        return new Iterable<Link>() {
+    public Iterable<LinkSpan> extractLinks(final CharSequence input) {
+        return new Iterable<LinkSpan>() {
             @Override
-            public Iterator<Link> iterator() {
+            public Iterator<LinkSpan> iterator() {
                 return new LinkIterator(input);
             }
         };
@@ -83,13 +83,13 @@ public LinkExtractor build() {
         }
     }
 
-    private static class LinkImpl implements Link {
+    private static class LinkSpanImpl implements LinkSpan {
 
         private final LinkType linkType;
         private final int beginIndex;
         private final int endIndex;
 
-        private LinkImpl(LinkType linkType, int beginIndex, int endIndex) {
+        private LinkSpanImpl(LinkType linkType, int beginIndex, int endIndex) {
             this.linkType = linkType;
             this.beginIndex = beginIndex;
             this.endIndex = endIndex;
@@ -116,11 +116,11 @@ public String toString() {
         }
     }
 
-    private class LinkIterator implements Iterator<Link> {
+    private class LinkIterator implements Iterator<LinkSpan> {
 
         private final CharSequence input;
 
-        private Link next = null;
+        private LinkSpan next = null;
         private int index = 0;
         private int rewindIndex = 0;
         private int[] result = new int[2];
@@ -136,9 +136,9 @@ public boolean hasNext() {
         }
 
         @Override
-        public Link next() {
+        public LinkSpan next() {
             if (hasNext()) {
-                Link link = next;
+                LinkSpan link = next;
                 next = null;
                 return link;
             } else {
@@ -157,7 +157,7 @@ private void setNext() {
                 if (scanner != null) {
                     boolean found = scanner.scan(input, index, rewindIndex, result);
                     if (found) {
-                        next = new LinkImpl(scanner.getLinkType(), result[0], result[1]);
+                        next = new LinkSpanImpl(scanner.getLinkType(), result[0], result[1]);
                         rewindIndex = result[1];
                         index = result[1];
                         break;

src/main/java/org/nibor/autolink/LinkRenderer.java

@@ -2,6 +2,6 @@
 
 public interface LinkRenderer {
 
-    void render(Link link, StringBuilder sb);
+    void render(LinkSpan link, StringBuilder sb);
 
 }

src/main/java/org/nibor/autolink/Link.java renamed to src/main/java/org/nibor/autolink/LinkSpan.java

@@ -3,7 +3,7 @@
 /**
  * Information for an extracted link.
  */
-public interface Link {
+public interface LinkSpan {
 
     /**
      * @return the type of link

src/test/java/org/nibor/autolink/AutolinkBenchmark.java

@@ -19,9 +19,9 @@ public class AutolinkBenchmark extends AutolinkTestCase {
 
     public static void main(String[] args) throws Exception {
         System.out.println("input length: " + GENERATED_INPUT.length());
-        Iterable<Link> links = LinkExtractor.builder().build().extractLinks(GENERATED_INPUT);
+        Iterable<LinkSpan> links = LinkExtractor.builder().build().extractLinks(GENERATED_INPUT);
         int count = 0;
-        for (Link ignore : links) {
+        for (LinkSpan ignore : links) {
             count++;
         }
         System.out.println("number of links: " + count);

src/test/java/org/nibor/autolink/AutolinkTestCase.java

@@ -17,10 +17,10 @@ protected void assertNotLinked(String input) {
     protected abstract LinkExtractor getLinkExtractor();
 
     protected String link(final String input, final String marker, final LinkType expectedLinkType) {
-        Iterable<Link> links = getLinkExtractor().extractLinks(input);
+        Iterable<LinkSpan> links = getLinkExtractor().extractLinks(input);
         return Autolink.renderLinks(input, links, new LinkRenderer() {
             @Override
-            public void render(Link link, StringBuilder sb) {
+            public void render(LinkSpan link, StringBuilder sb) {
                 if (expectedLinkType != null) {
                     assertEquals(expectedLinkType, link.getType());
                 }

src/test/java/org/nibor/autolink/AutolinkUrlTest.java

@@ -126,7 +126,7 @@ public void international() {
 
     @Test
     public void linkToString() {
-        Iterable<Link> links = getLinkExtractor().extractLinks("wow, so example: http://test.com");
+        Iterable<LinkSpan> links = getLinkExtractor().extractLinks("wow, so example: http://test.com");
         assertEquals("Link{type=URL, beginIndex=17, endIndex=32}", links.iterator().next().toString());
     }
 

src/test/java/org/nibor/autolink/LinkExtractorIterableTest.java

@@ -11,15 +11,15 @@ public class LinkExtractorIterableTest {
 
     @Test
     public void iteratorIsNew() {
-        Iterable<Link> iterable = getSingleElementIterable();
+        Iterable<LinkSpan> iterable = getSingleElementIterable();
         assertEquals(LinkType.URL, iterable.iterator().next().getType());
         assertEquals(LinkType.URL, iterable.iterator().next().getType());
     }
 
     @Test
     public void hasNextOnlyAdvancesOnce() {
-        Iterable<Link> iterable = getSingleElementIterable();
-        Iterator<Link> iterator = iterable.iterator();
+        Iterable<LinkSpan> iterable = getSingleElementIterable();
+        Iterator<LinkSpan> iterator = iterable.iterator();
         assertTrue(iterator.hasNext());
         assertTrue(iterator.hasNext());
         assertNotNull(iterator.next());
@@ -29,13 +29,13 @@ public void hasNextOnlyAdvancesOnce() {
 
     @Test(expected = NoSuchElementException.class)
     public void nextThrowsNoSuchElementException() {
-        Iterable<Link> iterable = getSingleElementIterable();
-        Iterator<Link> iterator = iterable.iterator();
+        Iterable<LinkSpan> iterable = getSingleElementIterable();
+        Iterator<LinkSpan> iterator = iterable.iterator();
         assertNotNull(iterator.next());
         iterator.next();
     }
 
-    private Iterable<Link> getSingleElementIterable() {
+    private Iterable<LinkSpan> getSingleElementIterable() {
         String input = "foo http://example.com";
         return LinkExtractor.builder().build().extractLinks(input);
     }