Remove unnecessary javadoc

This commit is contained in:
Clément Fournier committed 2018-02-16 00:25:06 +01:00
1 parent cd9f4f2248
commit d25fbcf8c0
27 files changed
+3 -267

No files matched your search

@@ -479,7 +479,7 @@ public abstract class AbstractNode implements Node {
/**
* {@inheritDoc}
*
*
* @deprecated The equivalence between toString and a node's name could be broken as soon as release 7.0.0.
* Use getXPathNodeName for that purpose. The use for debugging purposes is not deprecated.
@@ -28,81 +28,51 @@ import net.sf.saxon.value.Value;
* {@link #isSameNodeInfo(NodeInfo)}.
*/
public class AbstractNodeInfo implements VirtualNode, SiblingCountingNode {
/**
* {@inheritDoc}
*/
@Override
public String getSystemId() {
throw createUnsupportedOperationException("Source.getSystemId()");
}
/**
* {@inheritDoc}
*/
@Override
public void setSystemId(String systemId) {
throw createUnsupportedOperationException("Source.setSystemId(String)");
}
/**
* {@inheritDoc}
*/
@Override
public String getStringValue() {
throw createUnsupportedOperationException("ValueRepresentation.getStringValue()");
}
/**
* {@inheritDoc}
*/
@Override
public CharSequence getStringValueCS() {
throw createUnsupportedOperationException("ValueRepresentation.getStringValueCS()");
}
/**
* {@inheritDoc}
*/
@Override
public SequenceIterator getTypedValue() throws XPathException {
throw createUnsupportedOperationException("Item.getTypedValue()");
}
/**
* {@inheritDoc}
*/
@Override
public Object getUnderlyingNode() {
throw createUnsupportedOperationException("VirtualNode.getUnderlyingNode()");
}
/**
* {@inheritDoc}
*/
@Override
public int getSiblingPosition() {
throw createUnsupportedOperationException("SiblingCountingNode.getSiblingPosition()");
}
/**
* {@inheritDoc}
*/
@Override
public Value atomize() throws XPathException {
throw createUnsupportedOperationException("NodeInfo.atomize()");
}
/**
* {@inheritDoc}
*/
@Override
public int compareOrder(NodeInfo other) {
throw createUnsupportedOperationException("NodeInfo.compareOrder(NodeInfo)");
}
/**
* {@inheritDoc}
*/
@Override
public void copy(Receiver receiver, int whichNamespaces, boolean copyAnnotations, int locationId)
throws XPathException {
@@ -135,57 +105,36 @@ public class AbstractNodeInfo implements VirtualNode, SiblingCountingNode {
}
}
/**
* {@inheritDoc}
*/
@Override
public void generateId(FastStringBuffer buffer) {
throw createUnsupportedOperationException("NodeInfo.generateId(FastStringBuffer)");
}
/**
* {@inheritDoc}
*/
@Override
public String getAttributeValue(int fingerprint) {
throw createUnsupportedOperationException("NodeInfo.getAttributeValue(int)");
}
/**
* {@inheritDoc}
*/
@Override
public String getBaseURI() {
throw createUnsupportedOperationException("NodeInfo.getBaseURI()");
}
/**
* {@inheritDoc}
*/
@Override
public int getColumnNumber() {
throw createUnsupportedOperationException("NodeInfo.getColumnNumber()");
}
/**
* {@inheritDoc}
*/
@Override
public Configuration getConfiguration() {
throw createUnsupportedOperationException("NodeInfo.getConfiguration()");
}
/**
* {@inheritDoc}
*/
@Override
public int[] getDeclaredNamespaces(int[] buffer) {
throw createUnsupportedOperationException("NodeInfo.getDeclaredNamespaces(int[])");
}
/**
* {@inheritDoc}
*/
@Override
public String getDisplayName() {
throw createUnsupportedOperationException("NodeInfo.getDisplayName()");
@@ -201,129 +150,81 @@ public class AbstractNodeInfo implements VirtualNode, SiblingCountingNode {
return 0;
}
/**
* {@inheritDoc}
*/
@Override
public DocumentInfo getDocumentRoot() {
throw createUnsupportedOperationException("NodeInfo.getDocumentRoot()");
}
/**
* {@inheritDoc}
*/
@Override
public int getFingerprint() {
throw createUnsupportedOperationException("NodeInfo.getFingerprint()");
}
/**
* {@inheritDoc}
*/
@Override
public int getLineNumber() {
throw createUnsupportedOperationException("NodeInfo.getLineNumber()");
}
/**
* {@inheritDoc}
*/
@Override
public String getLocalPart() {
throw createUnsupportedOperationException("NodeInfo.getLocalPart()");
}
/**
* {@inheritDoc}
*/
@Override
public int getNameCode() {
throw createUnsupportedOperationException("NodeInfo.getNameCode()");
}
/**
* {@inheritDoc}
*/
@Override
public NamePool getNamePool() {
throw createUnsupportedOperationException("NodeInfo.getNamePool()");
}
/**
* {@inheritDoc}
*/
@Override
public int getNodeKind() {
throw createUnsupportedOperationException("NodeInfo.getNodeKind()");
}
/**
* {@inheritDoc}
*/
@Override
public NodeInfo getParent() {
throw createUnsupportedOperationException("NodeInfo.getParent()");
}
/**
* {@inheritDoc}
*/
@Override
public String getPrefix() {
throw createUnsupportedOperationException("NodeInfo.getPrefix()");
}
/**
* {@inheritDoc}
*/
@Override
public NodeInfo getRoot() {
throw createUnsupportedOperationException("NodeInfo.getRoot()");
}
/**
* {@inheritDoc}
*/
@Override
public int getTypeAnnotation() {
throw createUnsupportedOperationException("NodeInfo.getTypeAnnotation()");
}
/**
* {@inheritDoc}
*/
@Override
public String getURI() {
throw createUnsupportedOperationException("NodeInfo.getURI()");
}
/**
* {@inheritDoc}
*/
@Override
public boolean hasChildNodes() {
throw createUnsupportedOperationException("NodeInfo.hasChildNodes()");
}
/**
* {@inheritDoc}
*/
@Override
public boolean isId() {
throw createUnsupportedOperationException("NodeInfo.isId()");
}
/**
* {@inheritDoc}
*/
@Override
public boolean isIdref() {
throw createUnsupportedOperationException("NodeInfo.isIdref()");
}
/**
* {@inheritDoc}
*/
@Override
public boolean isNilled() {
throw createUnsupportedOperationException("NodeInfo.isNilled()");
@@ -340,9 +241,6 @@ public class AbstractNodeInfo implements VirtualNode, SiblingCountingNode {
return this.equals(other);
}
/**
* {@inheritDoc}
*/
@Override
public AxisIterator iterateAxis(byte axisNumber) {
throw createUnsupportedOperationException(
@@ -27,17 +27,11 @@ public class AttributeAxisIterator extends Navigator.BaseEnumeration {
this.iterator = new net.sourceforge.pmd.lang.ast.xpath.AttributeAxisIterator(startNodeInfo.node);
}
/**
* {@inheritDoc}
*/
@Override
public SequenceIterator getAnother() {
return new AttributeAxisIterator(startNodeInfo);
}
/**
* {@inheritDoc}
*/
@Override
public void advance() {
if (this.iterator.hasNext()) {
@@ -46,25 +46,16 @@ public class DocumentNode extends AbstractNodeInfo implements DocumentInfo {
this.rootNode = new ElementNode(this, new IdGenerator(), null, node, -1);
}
/**
* {@inheritDoc}
*/
@Override
public String[] getUnparsedEntity(String name) {
throw createUnsupportedOperationException("DocumentInfo.getUnparsedEntity(String)");
}
/**
* {@inheritDoc}
*/
@Override
public Iterator getUnparsedEntityNames() {
throw createUnsupportedOperationException("DocumentInfo.getUnparsedEntityNames()");
}
/**
* {@inheritDoc}
*/
@Override
public NodeInfo selectID(String id) {
throw createUnsupportedOperationException("DocumentInfo.selectID(String)");
@@ -37,17 +37,11 @@ public abstract class AbstractXPathRuleQuery implements XPathRuleQuery {
*/
protected final List<String> ruleChainVisits = new ArrayList<>();
/**
* {@inheritDoc}
*/
@Override
public void setXPath(final String xpath) {
this.xpath = xpath;
}
/**
* {@inheritDoc}
*/
@Override
public void setVersion(String version) throws UnsupportedOperationException {
if (!isSupportedVersion(version)) {
@@ -68,25 +62,16 @@ public abstract class AbstractXPathRuleQuery implements XPathRuleQuery {
*/
protected abstract boolean isSupportedVersion(String version);
/**
* {@inheritDoc}
*/
@Override
public void setProperties(Map<PropertyDescriptor<?>, Object> properties) {
this.properties = properties;
}
/**
* {@inheritDoc}
*/
@Override
public List<String> getRuleChainVisits() {
return ruleChainVisits;
}
/**
* {@inheritDoc}
*/
@Override
public abstract List<Node> evaluate(Node node, RuleContext data);
}
@@ -32,24 +32,15 @@ public abstract class AbstractAccumulatingRenderer extends AbstractRenderer {
super(name, description);
}
/**
* {@inheritDoc}
*/
@Override
public void start() throws IOException {
report = new Report();
}
/**
* {@inheritDoc}
*/
@Override
public void startFileAnalysis(DataSource dataSource) {
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileReport(Report report) throws IOException {
this.report.merge(report);
@@ -45,23 +45,14 @@ public abstract class AbstractIncrementingRenderer extends AbstractRenderer {
super(name, description);
}
/**
* {@inheritDoc}
*/
@Override
public void start() throws IOException {
}
/**
* {@inheritDoc}
*/
@Override
public void startFileAnalysis(DataSource dataSource) {
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileReport(Report report) throws IOException {
Iterator<RuleViolation> violations = report.iterator();
@@ -92,9 +83,6 @@ public abstract class AbstractIncrementingRenderer extends AbstractRenderer {
*/
public abstract void renderFileViolations(Iterator<RuleViolation> violations) throws IOException;
/**
* {@inheritDoc}
*/
@Override
public void end() throws IOException {
}
@@ -27,65 +27,41 @@ public abstract class AbstractRenderer extends AbstractPropertySource implements
this.description = description;
}
/**
* {@inheritDoc}
*/
@Override
public String getName() {
return name;
}
/**
* {@inheritDoc}
*/
@Override
public void setName(String name) {
this.name = name;
}
/**
* {@inheritDoc}
*/
@Override
public String getDescription() {
return description;
}
/**
* {@inheritDoc}
*/
@Override
public void setDescription(String description) {
this.description = description;
}
/**
* {@inheritDoc}
*/
@Override
public boolean isShowSuppressedViolations() {
return showSuppressedViolations;
}
/**
* {@inheritDoc}
*/
@Override
public void setShowSuppressedViolations(boolean showSuppressedViolations) {
this.showSuppressedViolations = showSuppressedViolations;
}
/**
* {@inheritDoc}
*/
@Override
public void setWriter(Writer writer) {
this.writer = writer;
}
/**
* {@inheritDoc}
*/
@Override
public Writer getWriter() {
return writer;
@@ -132,9 +132,6 @@ public class CSVRenderer extends AbstractIncrementingRenderer {
return csvWriter;
}
/**
* {@inheritDoc}
*/
@Override
public void start() throws IOException {
csvWriter().writeTitles(getWriter());
@@ -145,9 +142,6 @@ public class CSVRenderer extends AbstractIncrementingRenderer {
return "csv";
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
csvWriter().writeData(getWriter(), violations);
@@ -52,9 +52,6 @@ public class CodeClimateRenderer extends AbstractIncrementingRenderer {
return url;
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
Writer writer = getWriter();
@@ -28,9 +28,6 @@ public class EmacsRenderer extends AbstractIncrementingRenderer {
return "emacs";
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
Writer writer = getWriter();
@@ -75,9 +75,6 @@ public class HTMLRenderer extends AbstractIncrementingRenderer {
glomConfigurationErrors(writer, configErrors);
}
/**
* {@inheritDoc}
*/
@Override
public void start() throws IOException {
Writer writer = getWriter();
@@ -88,18 +85,12 @@ public class HTMLRenderer extends AbstractIncrementingRenderer {
+ "<th>#</th><th>File</th><th>Line</th><th>Problem</th></tr>" + PMD.EOL);
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
Writer writer = getWriter();
glomRuleViolations(writer, violations);
}
/**
* {@inheritDoc}
*/
@Override
public void end() throws IOException {
Writer writer = getWriter();
@@ -45,9 +45,6 @@ public class IDEAJRenderer extends AbstractIncrementingRenderer {
return "txt";
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
classAndMethodName = getProperty(CLASS_AND_METHOD_NAME);
@@ -31,9 +31,6 @@ public class SummaryHTMLRenderer extends AbstractAccumulatingRenderer {
return "html";
}
/**
* {@inheritDoc}
*/
@Override
public void end() throws IOException {
writer.write("<html><head><title>PMD</title></head><body>" + PMD.EOL);
@@ -109,9 +109,6 @@ public class TextColorRenderer extends AbstractAccumulatingRenderer {
return property != null && !("0".equals(property) || "false".equalsIgnoreCase(property));
}
/**
* {@inheritDoc}
*/
@Override
public void end() throws IOException {
StringBuilder buf = new StringBuilder(500);
@@ -49,9 +49,6 @@ public class TextPadRenderer extends AbstractIncrementingRenderer {
return "txt";
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
Writer writer = getWriter();
@@ -28,16 +28,10 @@ public class TextRenderer extends AbstractIncrementingRenderer {
return "txt";
}
/**
* {@inheritDoc}
*/
@Override
public void start() throws IOException {
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
Writer writer = getWriter();
@@ -53,9 +47,6 @@ public class TextRenderer extends AbstractIncrementingRenderer {
}
}
/**
* {@inheritDoc}
*/
@Override
public void end() throws IOException {
Writer writer = getWriter();
@@ -30,17 +30,11 @@ public class VBHTMLRenderer extends AbstractIncrementingRenderer {
return "vb.html";
}
/**
* {@inheritDoc}
*/
@Override
public void start() throws IOException {
getWriter().write(header());
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
if (!violations.hasNext()) {
@@ -87,9 +81,6 @@ public class VBHTMLRenderer extends AbstractIncrementingRenderer {
}
}
/**
* {@inheritDoc}
*/
@Override
public void end() throws IOException {
Writer writer = getWriter();
@@ -43,9 +43,6 @@ public class XMLRenderer extends AbstractIncrementingRenderer {
return "xml";
}
/**
* {@inheritDoc}
*/
@Override
public void start() throws IOException {
String encoding = getProperty(ENCODING);
@@ -64,9 +61,6 @@ public class XMLRenderer extends AbstractIncrementingRenderer {
writer.write(buf.toString());
}
/**
* {@inheritDoc}
*/
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
Writer writer = getWriter();
@@ -119,9 +113,6 @@ public class XMLRenderer extends AbstractIncrementingRenderer {
}
}
/**
* {@inheritDoc}
*/
@Override
public void end() throws IOException {
Writer writer = getWriter();
@@ -58,9 +58,6 @@ public class XSLTRenderer extends XMLRenderer {
return "xsl";
}
/**
* {@inheritDoc}
*/
@Override
public void start() throws IOException {
String xsltFilenameProperty = getProperty(XSLT_FILENAME);
@@ -113,9 +110,6 @@ public class XSLTRenderer extends XMLRenderer {
}
}
/**
* {@inheritDoc}
*/
@Override
public void end() throws IOException {
// First we finish the XML report
@@ -31,9 +31,6 @@ public class YAHTMLRenderer extends AbstractAccumulatingRenderer {
return "html";
}
/**
* {@inheritDoc}
*/
@Override
public void end() throws IOException {
String outputDir = getProperty(OUTPUT_DIR);
@@ -81,9 +81,6 @@ public class ClasspathClassLoader extends URLClassLoader {
return file.getAbsoluteFile().toURI().toURL();
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return new StringBuilder(getClass().getSimpleName())
@@ -29,17 +29,11 @@ public class CompoundIterator<T> implements Iterator<T> {
this.index = 0;
}
/**
* {@inheritDoc}
*/
@Override
public boolean hasNext() {
return getNextIterator() != null;
}
/**
* {@inheritDoc}
*/
@Override
public T next() {
Iterator<T> iterator = getNextIterator();
@@ -50,9 +44,6 @@ public class CompoundIterator<T> implements Iterator<T> {
}
}
/**
* {@inheritDoc}
*/
@Override
public void remove() {
Iterator<T> iterator = getNextIterator();
@@ -35,9 +35,6 @@ public class UseIndexOfCharRule extends AbstractPoorMethodCall {
return METHOD_NAMES;
}
/**
* {@inheritDoc}
*/
protected boolean isViolationArgument(Node arg) {
return ((ASTLiteral) arg).isSingleCharacterStringLiteral();
}
@@ -87,7 +87,7 @@ public class SourceFileScope extends AbstractJavaScope {
}
/**
* {@inheritDoc}
*
*
* @throws IllegalArgumentException
* if declaration is not a {@link ClassNameDeclaration}
@@ -27,7 +27,7 @@ public class SourceFileScope extends AbstractScope {
}
/**
* {@inheritDoc}
*
*
* @throws IllegalArgumentException
* if declaration is not a {@link ClassNameDeclaration}
@@ -45,9 +45,6 @@ public abstract class ASTMathNode extends AbstractVmNode {
super(p, id);
}
/**
* {@inheritDoc}
*/
@Override
public Object jjtAccept(final VmParserVisitor visitor, final Object data) {
return visitor.visit(this, data);