com.helger.jaxb22.plugin.PluginCloneable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-jaxb22-plugin Show documentation
Show all versions of ph-jaxb22-plugin Show documentation
JAXB 2.3 plugin to improve created output
/**
* Copyright (C) 2014-2019 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* 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.helger.jaxb22.plugin;
import java.util.ArrayList;
import java.util.Map;
import javax.annotation.Nonnull;
import org.xml.sax.ErrorHandler;
import com.helger.commons.annotation.IsSPIImplementation;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.CollectionHelper;
import com.helger.commons.collection.impl.ICommonsMap;
import com.sun.codemodel.JBlock;
import com.sun.codemodel.JClass;
import com.sun.codemodel.JCodeModel;
import com.sun.codemodel.JConditional;
import com.sun.codemodel.JDefinedClass;
import com.sun.codemodel.JExpr;
import com.sun.codemodel.JFieldVar;
import com.sun.codemodel.JForEach;
import com.sun.codemodel.JMethod;
import com.sun.codemodel.JMod;
import com.sun.codemodel.JVar;
import com.sun.tools.xjc.Options;
import com.sun.tools.xjc.outline.ClassOutline;
import com.sun.tools.xjc.outline.Outline;
/**
* Add getClone() method.
*
* @author Philip Helger
* @since 2.2.11.7
*/
@IsSPIImplementation
public class PluginCloneable extends AbstractPluginCloneable
{
private static final String OPT = "Xph-cloneable";
@Override
public String getOptionName ()
{
return OPT;
}
@Override
public String getUsage ()
{
return " -" + OPT + " : implement clone() of Cloneable interface and cloneTo(target)";
}
@Override
public boolean run (@Nonnull final Outline aOutline,
@Nonnull final Options aOpts,
@Nonnull final ErrorHandler aErrorHandler)
{
final JCodeModel aCodeModel = aOutline.getCodeModel ();
final JClass jObject = aCodeModel.ref (Object.class);
final JClass jCloneable = aCodeModel.ref (Cloneable.class);
final JClass jCollectionHelper = aCodeModel.ref (CollectionHelper.class);
final JClass jArrayList = aCodeModel.ref (ArrayList.class);
for (final ClassOutline aClassOutline : aOutline.getClasses ())
{
final JDefinedClass jClass = aClassOutline.implClass;
final boolean bIsRoot = jClass._extends () == null || jClass._extends ().equals (jObject);
if (bIsRoot)
{
// Implement Cloneable
jClass._implements (jCloneable);
}
final ICommonsMap aAllFields = getAllInstanceFields (aClassOutline);
// cloneTo
JMethod mCloneTo;
{
mCloneTo = jClass.method (JMod.PUBLIC, aCodeModel.VOID, "cloneTo");
// No @Override because parameter types are different in the class
// hierarchy
mCloneTo.javadoc ()
.add ("This method clones all values from this to the passed object. All data in the parameter object is overwritten!");
final JVar jRet = mCloneTo.param (jClass, "ret");
jRet.annotate (Nonnull.class);
mCloneTo.javadoc ().addParam (jRet).add ("The target object to clone to. May not be null.");
// Call from super class as well
if (!bIsRoot)
mCloneTo.body ().add (JExpr._super ().invoke (mCloneTo).arg (jRet));
for (final Map.Entry aEntry : aAllFields.entrySet ())
{
final JFieldVar aField = aEntry.getKey ();
if (aField.type ().erasure ().name ().equals ("List"))
{
// List
final JClass aTypeParam = ((JClass) aField.type ()).getTypeParameters ().get (0);
// if (x == null)
// ret.x = null;
final JConditional aIf = mCloneTo.body ()._if (aField.eq (JExpr._null ()));
aIf._then ().assign (jRet.ref (aField), JExpr._null ());
// else
{
final JBlock aJElse = aIf._else ();
// Ensure list is created :)
final JVar aTargetList = aJElse.decl (aField.type (),
"ret" + aEntry.getValue (),
JExpr._new (jArrayList.narrow (aTypeParam)));
// for (X aItem : getX())
final String sGetter = CJAXB22.getGetterName (aField.type (), aEntry.getValue ());
final JForEach jForEach = aJElse.forEach (aTypeParam, "aItem", JExpr.invoke (sGetter));
// aTargetList.add (_cloneOf_ (aItem))
jForEach.body ()
.add (aTargetList.invoke ("add").arg (_getCloneCode (aCodeModel, jForEach.var (), aTypeParam)));
aJElse.assign (jRet.ref (aField), aTargetList);
}
}
else
if (aField.type ().erasure ().name ().equals ("Map"))
{
// Map (for xs:anyAttribute/> - Map)
// has no setter - need to assign directly!
final JConditional aIf = mCloneTo.body ()._if (aField.eq (JExpr._null ()));
aIf._then ().assign (jRet.ref (aField), JExpr._null ());
aIf._else ().assign (jRet.ref (aField), jCollectionHelper.staticInvoke ("newMap").arg (aField));
}
else
{
mCloneTo.body ().assign (jRet.ref (aField), _getCloneCode (aCodeModel, aField, aField.type ()));
}
}
mCloneTo.javadoc ().add ("Created by " + CJAXB22.PLUGIN_NAME + " -" + OPT);
}
// Cannot instantiate abstract classes
if (jClass.isAbstract ())
{
// Create an abstract clone method
// clone
// Do not use "getClone" as this is the name of a JAXB generated method
// for the XSD Element "Clone" :(
final JMethod mClone = jClass.method (JMod.PUBLIC | JMod.ABSTRACT, jClass, "clone");
mClone.annotate (Nonnull.class);
mClone.annotate (ReturnsMutableCopy.class);
mClone.annotate (Override.class);
mClone.javadoc ().addReturn ().add ("The cloned object. Never null.");
mClone.javadoc ().add ("Created by " + CJAXB22.PLUGIN_NAME + " -" + OPT);
}
else
{
// clone
// Do not use "getClone" as this is the name of a JAXB generated method
// for the XSD Element "Clone" :(
final JMethod mClone = jClass.method (JMod.PUBLIC, jClass, "clone");
mClone.annotate (Nonnull.class);
mClone.annotate (ReturnsMutableCopy.class);
mClone.annotate (Override.class);
mClone.javadoc ().addReturn ().add ("The cloned object. Never null.");
final JVar jRet = mClone.body ().decl (jClass, "ret", JExpr._new (jClass));
mClone.body ().invoke (mCloneTo).arg (jRet);
mClone.body ()._return (jRet);
mClone.javadoc ().add ("Created by " + CJAXB22.PLUGIN_NAME + " -" + OPT);
}
// General information
jClass.javadoc ()
.add ("This class contains methods created by " + CJAXB22.PLUGIN_NAME + " -" + OPT + "
\n");
}
return true;
}
}