org.walkmod.sonar.visitors.StaticInitializedFieldToFinal Maven / Gradle / Ivy
/*
* SYSTEMi Copyright © 2015, MetricStream, Inc. All rights reserved.
*
* Walkmod is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Walkmod is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Walkmod. If not, see {
/** The m static fd. */
private Map mStaticFD;
/** The interface stack. */
private Stack interfaceStack;
/** Remove default value from fields. */
private boolean removeDefaultValue;
/** Added static final to interface fields. */
private boolean addStaticFinal = true;
/**
* Instantiates a new static initialized field to final.
*/
public StaticInitializedFieldToFinal() {
mStaticFD = new HashMap();
interfaceStack = new Stack();
}
/**
* Checks if is removes the default value.
*
* @return true, if is removes the default value
*/
public boolean isRemoveDefaultValue() {
return removeDefaultValue;
}
/**
* Sets the removes the default value.
*
* @param removeDefaultValue
* the new removes the default value
*/
public void setRemoveDefaultValue(boolean removeDefaultValue) {
this.removeDefaultValue = removeDefaultValue;
}
/**
* Checks if is adds the static final.
*
* @return true, if is adds the static final
*/
public boolean isAddStaticFinal() {
return addStaticFinal;
}
/**
* Sets the adds the static final.
*
* @param addStaticFinal
* the new adds the static final
*/
public void setAddStaticFinal(boolean addStaticFinal) {
this.addStaticFinal = addStaticFinal;
}
/*
* (non-Javadoc)
*
* @see org.walkmod.javalang.visitors.VoidVisitorAdapter#visit(org.walkmod.javalang.ast.CompilationUnit,
* java.lang.Object)
*/
@Override
public void visit(CompilationUnit n, VisitorContext arg) {
super.visit(n, arg);
Collection values = mStaticFD.values();
for (Iterator it = values.iterator(); it.hasNext();) {
FieldDeclaration fDeclaration = it.next();
if (fDeclaration == null) {
continue;
}
int modifiers = fDeclaration.getModifiers();
int sfmodifiers = ModifierSet.addModifier(modifiers, ModifierSet.FINAL);
fDeclaration.setModifiers(sfmodifiers);
}
}
/*
* (non-Javadoc)
*
* @see
* org.walkmod.javalang.visitors.VoidVisitorAdapter#visit(org.walkmod.javalang.ast.body.ClassOrInterfaceDeclaration,
* java.lang.Object)
*/
@Override
public void visit(ClassOrInterfaceDeclaration n, VisitorContext arg) {
interfaceStack.push(n.isInterface());
super.visit(n, arg);
interfaceStack.pop();
}
/*
* (non-Javadoc)
*
* @see org.walkmod.javalang.visitors.VoidVisitorAdapter#visit(org.walkmod.javalang.ast.body.EnumDeclaration,
* java.lang.Object)
*/
public void visit(EnumDeclaration n, VisitorContext arg) {
}
/*
* (non-Javadoc)
*
* @see org.walkmod.javalang.visitors.VoidVisitorAdapter#visit(org.walkmod.javalang.ast.body.FieldDeclaration,
* java.lang.Object)
*/
@Override
public void visit(FieldDeclaration n, VisitorContext arg) {
int modifiers = n.getModifiers();
boolean isInterface = interfaceStack.peek();
if (isInterface) {
if (isAddStaticFinal()) {
if (!ModifierSet.isPublic(modifiers)) {
modifiers = ModifierSet.addModifier(modifiers, ModifierSet.PUBLIC);
}
if (!ModifierSet.isStatic(modifiers)) {
modifiers = ModifierSet.addModifier(modifiers, ModifierSet.STATIC);
}
if (!ModifierSet.isFinal(modifiers)) {
modifiers = ModifierSet.addModifier(modifiers, ModifierSet.FINAL);
}
n.setModifiers(modifiers);
}
return;
}
if (ModifierSet.isFinal(modifiers) || !ModifierSet.isStatic(modifiers)) {
return;
}
List variables = n.getVariables();
if (variables.size() != 1) {
return;
}
VariableDeclarator vDeclarator = variables.get(0);
Expression init = vDeclarator.getInit();
if (init == null || hasDefaultValue(vDeclarator, init)) {
return;
}
if (!mStaticFD.containsKey(vDeclarator.getId().getName())) {
mStaticFD.put(vDeclarator.getId().getName(), n);
}
}
/**
* Checks for default value.
*
* @param vDeclarator
* the v declarator
* @param init
* the init
* @return true, if successful
*/
private boolean hasDefaultValue(VariableDeclarator vDeclarator, Expression init) {
boolean setEmpty = false;
if (init instanceof NullLiteralExpr) {
setEmpty = true;
} else if (init instanceof IntegerLiteralExpr) {
if (((IntegerLiteralExpr) init).getValue().equals("0")) {
setEmpty = true;
}
} else if (init instanceof LongLiteralExpr) {
String value = ((LongLiteralExpr) init).getValue();
if (value.equalsIgnoreCase("0l")) {
setEmpty = true;
}
} else if (init instanceof DoubleLiteralExpr) {
String value = ((DoubleLiteralExpr) init).getValue();
if (value.equalsIgnoreCase("0f") || value.equalsIgnoreCase("0d")) {
setEmpty = true;
}
} else if (init instanceof BooleanLiteralExpr) {
if (!((BooleanLiteralExpr) init).getValue()) {
setEmpty = true;
}
}
if (setEmpty && isRemoveDefaultValue()) {
vDeclarator.setInit(null);
}
return setEmpty;
}
/*
* (non-Javadoc)
*
* @see org.walkmod.javalang.visitors.VoidVisitorAdapter#visit(org.walkmod.javalang.ast.body.ConstructorDeclaration,
* java.lang.Object)
*/
@Override
public void visit(ConstructorDeclaration n, VisitorContext arg) {
super.visit(n, arg);
}
/*
* (non-Javadoc)
*
* @see org.walkmod.javalang.visitors.VoidVisitorAdapter#visit(org.walkmod.javalang.ast.expr.AssignExpr,
* java.lang.Object)
*/
@Override
public void visit(AssignExpr n, VisitorContext arg) {
Expression target = n.getTarget();
if (target instanceof NameExpr) {
mStaticFD.put(((NameExpr) target).getName(), null);
} else if (target instanceof FieldAccessExpr) {
mStaticFD.put(((FieldAccessExpr) target).getField(), null);
}
super.visit(n, arg);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy