org.codehaus.groovy.ast.PropertyNode Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of groovy Show documentation
Show all versions of groovy Show documentation
Groovy: A powerful multi-faceted language for the JVM
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.codehaus.groovy.ast;
import groovy.lang.MetaProperty;
import org.codehaus.groovy.ast.expr.Expression;
import org.codehaus.groovy.ast.stmt.Statement;
import static org.objectweb.asm.Opcodes.ACC_PRIVATE;
import static org.objectweb.asm.Opcodes.ACC_PUBLIC;
import static org.objectweb.asm.Opcodes.ACC_STATIC;
import static org.apache.groovy.util.BeanUtils.capitalize;
/**
* Represents a property (member variable, a getter and setter)
*/
public class PropertyNode extends AnnotatedNode implements Variable {
private FieldNode field;
private Statement getterBlock;
private Statement setterBlock;
private String getterName = null;
private String setterName = null;
private final int modifiers;
public PropertyNode(
String name, int modifiers, ClassNode type, ClassNode owner,
Expression initialValueExpression, Statement getterBlock,
Statement setterBlock) {
this(new FieldNode(name, modifiers & ACC_STATIC, type, owner, initialValueExpression), modifiers, getterBlock, setterBlock);
}
public PropertyNode(FieldNode field, int modifiers, Statement getterBlock, Statement setterBlock) {
this.field = field;
this.modifiers = modifiers;
this.getterBlock = getterBlock;
this.setterBlock = setterBlock;
}
public Statement getGetterBlock() {
return getterBlock;
}
public Expression getInitialExpression() {
return field.getInitialExpression();
}
public void setGetterBlock(Statement getterBlock) {
this.getterBlock = getterBlock;
}
public void setSetterBlock(Statement setterBlock) {
this.setterBlock = setterBlock;
}
public String getGetterName() {
return getterName;
}
/**
* If an explicit getterName has been set, return that, otherwise return the default name for the property.
* For a property {@code foo}, the default name is {@code getFoo} except for a boolean property where
* {@code isFoo} is the default if no {@code getFoo} method exists in the declaring class.
*/
public String getGetterNameOrDefault() {
// return setterName != null ? setterName : MetaProperty.getSetterName(getName());
if (getterName != null) return getterName;
String defaultName = "get" + capitalize(getName());
if (ClassHelper.boolean_TYPE.equals(getOriginType())
&& getDeclaringClass().getMethod(defaultName, Parameter.EMPTY_ARRAY) == null) {
defaultName = "is" + capitalize(getName());
}
return defaultName;
}
public void setGetterName(String getterName) {
if (getterName == null || getterName.isEmpty()) {
throw new IllegalArgumentException("A non-null non-empty getter name is required");
}
this.getterName = getterName;
}
public String getSetterName() {
return setterName;
}
public String getSetterNameOrDefault() {
return setterName != null ? setterName : MetaProperty.getSetterName(getName());
}
public void setSetterName(String setterName) {
if (setterName == null || setterName.isEmpty()) {
throw new IllegalArgumentException("A non-null non-empty setter name is required");
}
this.setterName = setterName;
}
public int getModifiers() {
return modifiers;
}
public String getName() {
return field.getName();
}
public Statement getSetterBlock() {
return setterBlock;
}
public ClassNode getType() {
return field.getType();
}
public void setType(ClassNode t) {
field.setType(t);
}
public FieldNode getField() {
return field;
}
public void setField(FieldNode fn) {
field = fn;
}
public boolean isPrivate() {
return (modifiers & ACC_PRIVATE) != 0;
}
public boolean isPublic() {
return (modifiers & ACC_PUBLIC) != 0;
}
public boolean isStatic() {
return (modifiers & ACC_STATIC) != 0;
}
public boolean hasInitialExpression() {
return field.hasInitialExpression();
}
public boolean isInStaticContext() {
return field.isInStaticContext();
}
public boolean isDynamicTyped() {
return field.isDynamicTyped();
}
public boolean isClosureSharedVariable() {
return false;
}
/**
* @deprecated not used anymore, has no effect
*/
@Deprecated
public void setClosureSharedVariable(boolean inClosure) {
// unused
}
public ClassNode getOriginType() {
return getType();
}
}