phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update GenericToken interface to expose directly region methods

Browse Source
This commit is contained in:
gonzalo
2017-10-22 21:10:43 -03:00
parent 0e011767ce
commit e8fdbdbca4
13 changed files with 235 additions and 183 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/GenericToken.java
View File

@ -22,15 +22,33 @@ public interface GenericToken {
*/
GenericToken getPreviousSpecialGenericToken();
/**
* Obtain the region where the token occupies in the source file.
* @return the region
*/
RegionByLine getRegionByLine();
/**
* Gets the token's text.
* @return the token's text
*/
String getImage();
/**
* Gets the line where the token's region begins
* @return a non-negative integer containing the begin line
*/
int getBeginLine();
/**
* Gets the line where the token's region ends
* @return a non-negative integer containing the end line
*/
int getEndLine();
/**
* Gets the column offset from the start of the begin line where the token's region begins
* @return a non-negative integer containing the begin column
*/
int getBeginColumn();
/**
* Gets the column offset from the start of the end line where the token's region ends
* @return a non-negative integer containing the begin column
*/
int getEndColumn();
}

35
pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/RegionByLine.java
View File

@ -1,35 +0,0 @@
/**
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
package net.sourceforge.pmd.lang.ast;
/**
* Represents a region in a source file bounded by a (beginLine, beginColumn) and (endLine, endColumn).
*/
public interface RegionByLine {
/**
* Gets the line where the region begins
* @return a non-negative integer containing the begin line
*/
int getBeginLine();
/**
* Gets the line where the region ends
* @return a non-negative integer containing the end line
*/
int getEndLine();
/**
* Gets the column offset from the start of the begin line where the region begins
* @return a non-negative integer containing the begin column
*/
int getBeginColumn();
/**
* Gets the column offset from the start of the end line where the region ends
* @return a non-negative integer containing the begin column
*/
int getEndColumn();
}

72
pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/RegionByLineImpl.java
View File

@ -1,72 +0,0 @@
/**
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
package net.sourceforge.pmd.lang.ast;
/**
* Default immutable implementation for the RegionByLine interface which is used by {@link GenericToken}
*/
public class RegionByLineImpl implements RegionByLine {
private int beginLine;
private int endLine;
private int beginColumn;
private int endColumn;
/**
* Create an immutable instance with all the corresponding fields. Every field requires to be non-negative
* @param beginLine the line where the region begins
* @param endLine the line where the region ends
* @param beginColumn the column offset from the start of the begin line where the region begins
* @param endColumn the column offset from the start of the end line where the region ends
*/
public RegionByLineImpl(final int beginLine, final int endLine, final int beginColumn, final int endColumn) {
setBeginLine(beginLine);
setEndLine(endLine);
setBeginColumn(beginColumn);
setEndColumn(endColumn);
}
private void setBeginLine(final int beginLine) {
this.beginLine = requireNonNegative(beginLine);
}
private void setEndLine(final int endLine) {
this.endLine = requireNonNegative(endLine);
}
private void setBeginColumn(final int beginColumn) {
this.beginColumn = requireNonNegative(beginColumn);
}
private void setEndColumn(final int endColumn) {
this.endColumn = requireNonNegative(endColumn);
}
private int requireNonNegative(final int value) {
if (value < 0) {
throw new IllegalArgumentException("value = " + value + " must be non-negative");
}
return value;
}
@Override
public int getBeginLine() {
return beginLine;
}
@Override
public int getEndLine() {
return endLine;
}
@Override
public int getBeginColumn() {
return beginColumn;
}
@Override
public int getEndColumn() {
return endColumn;
}
}