com.google.gwt.uibinder.elementparsers.BeanParser Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2007 Google Inc.
*
* Licensed 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 com.google.gwt.uibinder.elementparsers;
import com.google.gwt.core.ext.UnableToCompleteException;
import com.google.gwt.core.ext.typeinfo.JAbstractMethod;
import com.google.gwt.core.ext.typeinfo.JClassType;
import com.google.gwt.core.ext.typeinfo.JMethod;
import com.google.gwt.core.ext.typeinfo.JParameter;
import com.google.gwt.core.ext.typeinfo.JType;
import com.google.gwt.uibinder.rebind.UiBinderContext;
import com.google.gwt.uibinder.rebind.UiBinderWriter;
import com.google.gwt.uibinder.rebind.XMLAttribute;
import com.google.gwt.uibinder.rebind.XMLElement;
import com.google.gwt.uibinder.rebind.messages.AttributeMessage;
import com.google.gwt.uibinder.rebind.model.OwnerField;
import com.google.gwt.uibinder.rebind.model.OwnerFieldClass;
import java.util.Collection;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
/**
* Utility methods for discovering bean-like properties and generating code to
* initialize them.
*/
public class BeanParser implements ElementParser {
/**
* Mapping between parameters and special UIObject methods. The {@link UIObjectParser} has a few
* methods that extend the normal bean naming pattern. So, that implementations of
* {@link IsWidget} behave like UIObjects, they have to be translated.
*/
private static final Map ADD_PROPERTY_TO_SETTER_MAP =
new HashMap() { {
put("addStyleNames", "addStyleName");
put("addStyleDependentNames", "addStyleDependentName");
}};
private final UiBinderContext context;
public BeanParser(UiBinderContext context) {
this.context = context;
}
/**
* Generates code to initialize all bean attributes on the given element.
* Includes support for <ui:attribute /> children that will apply to
* setters
*
* @throws UnableToCompleteException
*/
public void parse(XMLElement elem, String fieldName, JClassType type,
UiBinderWriter writer) throws UnableToCompleteException {
writer.getDesignTime().handleUIObject(writer, elem, fieldName);
final Map setterValues = new HashMap();
final Map localizedValues = fetchLocalizedAttributeValues(
elem, writer);
final Map adderValues = new HashMap<>();
final Map requiredValues = new HashMap();
final Map unfilledRequiredParams = new HashMap();
final OwnerFieldClass ownerFieldClass = OwnerFieldClass.getFieldClass(type,
writer.getLogger(), context);
/*
* Handle @UiFactory and @UiConstructor, but only if the user
* hasn't provided an instance via @UiField(provided = true)
*/
JAbstractMethod creator = null;
OwnerField uiField = writer.getOwnerClass().getUiField(fieldName);
if ((uiField == null) || (!uiField.isProvided())) {
// See if there's a factory method
creator = writer.getOwnerClass().getUiFactoryMethod(type);
if (creator == null) {
// If not, see if there's a @UiConstructor
creator = ownerFieldClass.getUiConstructor();
}
if (creator != null) {
for (JParameter param : creator.getParameters()) {
unfilledRequiredParams.put(param.getName(), param.getType());
}
}
}
// Work through the localized attribute values and assign them
// to appropriate constructor params or setters (which had better be
// ready to accept strings)
for (Entry property : localizedValues.entrySet()) {
String key = property.getKey();
String value = property.getValue();
JType paramType = unfilledRequiredParams.get(key);
if (paramType != null) {
if (!isString(writer, paramType)) {
writer.die(elem,
"In %s, cannot apply message attribute to non-string "
+ "constructor argument %s.",
paramType.getSimpleSourceName(), key);
}
requiredValues.put(key, value);
unfilledRequiredParams.remove(key);
} else {
JMethod setter = ownerFieldClass.getSetter(key);
JParameter[] params = setter == null ? null : setter.getParameters();
if (setter == null || !(params.length == 1)
|| !isString(writer, params[0].getType())) {
writer.die(elem, "No method found to apply message attribute %s", key);
} else {
setterValues.put(key, value);
}
}
}
// Now go through the element and dispatch its attributes, remembering
// that constructor arguments get first dibs
for (int i = elem.getAttributeCount() - 1; i >= 0; i--) {
// Backward traversal b/c we're deleting attributes from the xml element
XMLAttribute attribute = elem.getAttribute(i);
// Ignore xmlns attributes
if (attribute.getName().startsWith("xmlns:")) {
continue;
}
String propertyName = attribute.getLocalName();
if (setterValues.keySet().contains(propertyName)
|| requiredValues.containsKey(propertyName)) {
writer.die(elem, "Duplicate attribute name: %s", propertyName);
}
if (unfilledRequiredParams.keySet().contains(propertyName)) {
JType paramType = unfilledRequiredParams.get(propertyName);
String value = elem.consumeAttributeWithDefault(attribute.getName(),
null, paramType);
if (value == null) {
writer.die(elem, "Unable to parse %s as constructor argument "
+ "of type %s", attribute, paramType.getSimpleSourceName());
}
requiredValues.put(propertyName, value);
unfilledRequiredParams.remove(propertyName);
} else {
JMethod setter = ownerFieldClass.getSetter(propertyName);
if (setter != null) {
String n = attribute.getName();
String value = elem.consumeAttributeWithDefault(n, null, getParamTypes(setter));
if (value == null) {
writer.die(elem, "Unable to parse %s.", attribute);
}
setterValues.put(propertyName, value);
} else if (ADD_PROPERTY_TO_SETTER_MAP.containsKey(propertyName)) {
String addMethod = ADD_PROPERTY_TO_SETTER_MAP.get(propertyName);
JType stringType = writer.getOracle().findType(String.class.getName());
if (ownerFieldClass.getRawType().findMethod(addMethod, new JType[]{stringType}) != null) {
String n = attribute.getName();
String[] value = elem.consumeStringArrayAttribute(n);
if (value == null) {
writer.die(elem, "Unable to parse %s.", attribute);
}
adderValues.put(addMethod, value);
} else {
writer.die(elem, "Class %s has no appropriate %s() method",
elem.getLocalName(), addMethod);
}
} else {
writer.die(elem, "Class %s has no appropriate set%s() method",
elem.getLocalName(), initialCap(propertyName));
}
}
}
if (!unfilledRequiredParams.isEmpty()) {
StringBuilder b = new StringBuilder(String.format(
"%s missing required attribute(s):", elem));
for (String name : unfilledRequiredParams.keySet()) {
b.append(" ").append(name);
}
writer.die(elem, b.toString());
}
if (creator != null) {
String[] args = makeArgsList(requiredValues, creator);
if (creator instanceof JMethod) { // Factory method
JMethod factoryMethod = (JMethod) creator;
String initializer;
if (writer.getDesignTime().isDesignTime()) {
String typeName = factoryMethod.getReturnType().getQualifiedSourceName();
initializer = writer.getDesignTime().getProvidedFactory(typeName,
factoryMethod.getName(),
UiBinderWriter.asCommaSeparatedList(args));
} else {
initializer = String.format("owner.%s(%s)", factoryMethod.getName(),
UiBinderWriter.asCommaSeparatedList(args));
}
writer.setFieldInitializer(fieldName, initializer);
} else { // Annotated Constructor
writer.setFieldInitializerAsConstructor(fieldName, args);
}
}
for (Map.Entry entry : setterValues.entrySet()) {
String propertyName = entry.getKey();
String value = entry.getValue();
writer.addStatement("%s.set%s(%s);", fieldName, initialCap(propertyName),
value);
}
for (Map.Entry entry : adderValues.entrySet()) {
String addMethodName = entry.getKey();
for (String s : entry.getValue()) {
writer.addStatement("%s.%s(%s);", fieldName, addMethodName, s);
}
}
}
/**
* Fetch the localized attributes that were stored by the
* AttributeMessageParser.
*/
private Map fetchLocalizedAttributeValues(XMLElement elem,
UiBinderWriter writer) {
final Map localizedValues = new HashMap();
Collection attributeMessages = writer.getMessages().retrieveMessageAttributesFor(
elem);
if (attributeMessages != null) {
for (AttributeMessage att : attributeMessages) {
String propertyName = att.getAttribute();
localizedValues.put(propertyName, att.getMessageUnescaped());
}
}
return localizedValues;
}
private JType[] getParamTypes(JMethod setter) {
JParameter[] params = setter.getParameters();
JType[] types = new JType[params.length];
for (int i = 0; i < params.length; i++) {
types[i] = params[i].getType();
}
return types;
}
private String initialCap(String propertyName) {
return propertyName.substring(0, 1).toUpperCase(Locale.ROOT)
+ propertyName.substring(1);
}
private boolean isString(UiBinderWriter writer, JType paramType) {
JType stringType = writer.getOracle().findType(String.class.getName());
return stringType.equals(paramType);
}
private String[] makeArgsList(final Map valueMap,
JAbstractMethod method) {
JParameter[] params = method.getParameters();
String[] args = new String[params.length];
int i = 0;
for (JParameter param : params) {
args[i++] = valueMap.get(param.getName());
}
return args;
}
}