#1 polished a bit

jcabi · Oct 23, 2013 · 3eb22ef · 3eb22ef
1 parent 41f9033
commit 3eb22ef
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 116 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
 target/
+.idea/
+*.iml
diff --git a/src/main/java/com/jcabi/xml/DomParser.java b/src/main/java/com/jcabi/xml/DomParser.java
@@ -83,7 +83,7 @@ final class DomParser {
      *
      * @param txt The XML in text
      */
-    protected DomParser(@NotNull final String txt) {
+    DomParser(@NotNull final String txt) {
         if (txt.isEmpty()) {
             throw new IllegalArgumentException("Empty document, not an XML");
         }
@@ -101,7 +101,7 @@ protected DomParser(@NotNull final String txt) {
      */
     @NotNull
     public Document document() {
-        Document doc;
+        final Document doc;
         try {
             final DocumentBuilderFactory factory =
                 DocumentBuilderFactory.newInstance();

diff --git a/src/main/java/com/jcabi/xml/DomPrinter.java b/src/main/java/com/jcabi/xml/DomPrinter.java
@@ -34,6 +34,8 @@
 import javax.validation.constraints.NotNull;
 import javax.xml.transform.OutputKeys;
 import javax.xml.transform.Transformer;
+import javax.xml.transform.TransformerConfigurationException;
+import javax.xml.transform.TransformerException;
 import javax.xml.transform.TransformerFactory;
 import javax.xml.transform.dom.DOMSource;
 import javax.xml.transform.stream.StreamResult;
@@ -68,13 +70,10 @@ final class DomPrinter {
      * Public ctor.
      * @param elm The node
      */
-    protected DomPrinter(@NotNull final Node elm) {
+    DomPrinter(@NotNull final Node elm) {
         this.node = elm;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public String toString() {
         final StringWriter writer = new StringWriter();
@@ -86,9 +85,9 @@ public String toString() {
                 new DOMSource(this.node),
                 new StreamResult(writer)
             );
-        } catch (javax.xml.transform.TransformerConfigurationException ex) {
+        } catch (TransformerConfigurationException ex) {
             throw new IllegalStateException(ex);
-        } catch (javax.xml.transform.TransformerException ex) {
+        } catch (TransformerException ex) {
             throw new IllegalArgumentException(ex);
         }
         return writer.toString();

diff --git a/src/main/java/com/jcabi/xml/ListWrapper.java b/src/main/java/com/jcabi/xml/ListWrapper.java
@@ -99,65 +99,44 @@ final class ListWrapper<T> implements List<T> {
      * @param node The XML
      * @param addr Address
      */
-    protected ListWrapper(@NotNull final List<T> list, @NotNull final Node node,
+    ListWrapper(@NotNull final List<T> list, @NotNull final Node node,
         @NotNull final String addr) {
         this.original = list;
         this.dom = node;
         this.xpath = addr;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean add(@NotNull final T element) {
         throw new UnsupportedOperationException("#add(T)");
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void add(final int index, @NotNull final T element) {
         throw new UnsupportedOperationException("#add(int, T)");
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean addAll(@NotNull final Collection<? extends T> elements) {
         throw new UnsupportedOperationException("#addAll(Collection)");
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean addAll(final int index,
         @NotNull final Collection<? extends T> elements) {
         throw new UnsupportedOperationException("#add(int, Collection)");
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void clear() {
         throw new UnsupportedOperationException("#clear()");
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean contains(@NotNull final Object element) {
         return this.original.contains(element);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean containsAll(@NotNull final Collection<?> elements) {
         return this.original.containsAll(elements);
@@ -176,8 +155,7 @@ public T get(final int index) {
             throw new ListWrapper.NodeNotFoundException(
                 String.format(
                     "Index (%d) is out of bounds (size=%d)",
-                    index,
-                    this.size()
+                    index, this.size()
                 ),
                 this.dom,
                 this.xpath
@@ -186,100 +164,64 @@ public T get(final int index) {
         return this.original.get(index);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public int indexOf(@NotNull final Object element) {
         return this.original.indexOf(element);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean isEmpty() {
         return this.original.isEmpty();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     @NotNull
     public Iterator<T> iterator() {
         return this.original.iterator();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public int lastIndexOf(@NotNull final Object element) {
         return this.original.lastIndexOf(element);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     @NotNull
     public ListIterator<T> listIterator() {
         return this.original.listIterator();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     @NotNull
     public ListIterator<T> listIterator(final int index) {
         return this.original.listIterator(index);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public T remove(final int index) {
         throw new UnsupportedOperationException("#remove(int)");
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean remove(@NotNull final Object element) {
         throw new UnsupportedOperationException("#remove(Object)");
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean removeAll(@NotNull final Collection<?> elements) {
         throw new UnsupportedOperationException("#removeAll(Collection)");
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public boolean retainAll(@NotNull final Collection<?> elements) {
         throw new UnsupportedOperationException("#retainAll(Collection)");
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public T set(final int index, @NotNull final T element) {
         throw new UnsupportedOperationException("#set(int, T)");
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public int size() {
         return this.original.size();
@@ -303,8 +245,7 @@ public List<T> subList(final int start, final int end) {
             throw new ListWrapper.NodeNotFoundException(
                 String.format(
                     "Start of subList (%d) is out of bounds (size=%d)",
-                    start,
-                    this.size()
+                    start, this.size()
                 ),
                 this.dom,
                 this.xpath
@@ -314,8 +255,7 @@ public List<T> subList(final int start, final int end) {
             throw new ListWrapper.NodeNotFoundException(
                 String.format(
                     "End of subList (%d) is out of bounds (size=%d)",
-                    end,
-                    this.size()
+                    end, this.size()
                 ),
                 this.dom,
                 this.xpath
@@ -324,17 +264,11 @@ public List<T> subList(final int start, final int end) {
         return this.original.subList(start, end);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public Object[] toArray() {
         return this.original.toArray();
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public <E> E[] toArray(@NotNull final E[] array) {
         return this.original.toArray(array);
@@ -355,7 +289,7 @@ private static final class NodeNotFoundException
          * @param node The XML with error
          * @param xpath The address
          */
-        protected NodeNotFoundException(@NotNull final String message,
+        NodeNotFoundException(@NotNull final String message,
             @NotNull final Node node, @NotNull final String xpath) {
             super(
                 Logger.format(

diff --git a/src/main/java/com/jcabi/xml/XML.java b/src/main/java/com/jcabi/xml/XML.java
@@ -113,7 +113,7 @@ public interface XML {
      * </pre>
      *
      * <p>A number of standard namespaces are registered by default in
-     * instances of {@link XML}. Their
+     * instances of XML. Their
      * full list is in {@link XMLDocument#XMLDocument(String)}.
      *
      * <p>If a namespace prefix is already registered an
-Original file line number
+Diff line change
@@ -1 +1,3 @@
     target/
+    .idea/
+    *.iml