Update to 2.3 of Speedment

Author: Emil Forslund

src/main/java/com/speedment/annotation/Api.java

@@ -0,0 +1,62 @@
+/**
+ *
+ * Copyright (c) 2006-2016, Speedment, Inc. All Rights Reserved.
+ *
+ * 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.speedment.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marks a Method, Type or Constructor as an API. An API marked entity with a
+ * certain API version will remain "Compatible" across new software releases
+ * indefinitely , for that particular API version.
+ * <p>
+ * "Compatible" is defined as follows:
+ * <p>
+ * Method: Its signature (i.e. name and parameters), and return type will
+ * remain.
+ * <p>
+ * Interface: Its name and all its declared methods with its return type and
+ * signature and static fields will remain. New methods and static field might
+ * be added.
+ * <p>
+ * Enum: Its elements will remain and their individual order will remain. New
+ * elements might be added.
+ *
+ * @author pemi
+ */
+@Api(version = "2.3", snapshot = false)
+@Retention(value = RetentionPolicy.RUNTIME)
+@Target({ElementType.METHOD, ElementType.TYPE, ElementType.CONSTRUCTOR})
+public @interface Api {
+
+ /**
+ * Returns the current API version.
+ *
+ * @return the current API version.
+ */
+ String version();
+
+ /**
+ * Returns if this API version is a snapshot, i.e. it is not yet "frozen"
+ * and may change within the given API version.
+ *
+ * @return true if this API version is a snapshot, false otherwise.
+ */
+ boolean snapshot() default false;
+}

src/main/java/com/speedment/annotation/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * Annotations used in generated code is located in this package. 
+ * <p>
+ * This package is part of the API. Modifications to classes here should only
+ * (if ever) be done in major releases.
+ */
+package com.speedment.annotation;

src/main/java/com/speedment/codegen/DependencyManager.java

@@ -0,0 +1,102 @@
+/**
+ *
+ * Copyright (c) 2006-2016, Speedment, Inc. All Rights Reserved.
+ *
+ * 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.speedment.codegen;
+
+import com.speedment.annotation.Api;
+import java.util.Optional;
+
+/**
+ * Keeps track of which dependencies have been imported and which is not
+ * included. This is useful for solving the issue of when to write the full name
+ * of a class and when to only include the short name.
+ *
+ * @author Emil Forslund
+ * @since 2.0
+ */
+@Api(version = "2.3")
+public interface DependencyManager {
+
+ /**
+ * Attempts to add the specified resource to the dependency list. If the
+ * name is already taken it will return {@code false}.
+ *
+ * @param fullname the full name of the resource.
+ * @return {@code true} if it was added, else <code>false</code>
+ */
+ boolean load(String fullname);
+
+ /**
+ * Returns <code>true</code> if the specified fullname is either:
+ *
+ * <pre>
+ *	(A) loaded into the dependency list;
+ *	(B) on the ignore list.
+ * </pre>
+ *
+ * Else it returns <code>false</code>.
+ *
+ * @param fullname the full name of the resource.
+ * @return {@code true} if it don't have to be loaded.
+ */
+ boolean isLoaded(String fullname);
+
+ /**
+ * Returns true if the specified class belongs to a package that is on the
+ * ignore list.
+ *
+ * @param fullname the full name of a package or a class
+ * @return {@code true} if it should be ignored as a dependency
+ */
+ boolean isIgnored(String fullname);
+
+ /**
+ * Clear all dependencies.
+ */
+ void clearDependencies();
+
+ /**
+ * Attempts to set the package that is currently being rendered. If a
+ * package is already set, the operation will fail and {@code false} will be
+ * returned. If the operation succeeded, {@code true} is returned and the
+ * {@code DependencyManager} will expect
+ * {@link #unsetCurrentPackage(java.lang.String)} to be called later before
+ * the generation is finished.
+ *
+ * @param pack the new current package
+ * @return {@code true} if the operation succeeded, else {@code false}
+ */
+ boolean setCurrentPackage(String pack);
+
+ /**
+ * Attempts to unset the currently rendered package. If the specified
+ * package is the one that is currently being rendered, it will be unset and
+ * {@code true} will be returned. If the package specified is not correct,
+ * the current package will <b>not</b> be unset and {@code false} will be
+ * returned. If no package was set the operation will throw an
+ * {@link IllegalStateException}.
+ *
+ * @param pack the current package to unset
+ * @return {@code true} if the operation succeeded, else {@code false}
+ */
+ boolean unsetCurrentPackage(String pack);
+ 
+ /**
+ * Returns the current package if one is set, or else {@code empty}.
+ * @return the package
+ */
+ Optional<String> getCurrentPackage();
+}

src/main/java/com/speedment/codegen/base/Generator.java renamed to src/main/java/com/speedment/codegen/Generator.java

@@ -1,6 +1,6 @@
 /**
  *
- * Copyright (c) 2006-2015, Speedment, Inc. All Rights Reserved.
+ * Copyright (c) 2006-2016, Speedment, Inc. All Rights Reserved.
  *
  * 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
@@ -14,8 +14,9 @@
  * License for the specific language governing permissions and limitations under
  * the License.
  */
-package com.speedment.codegen.base;
+package com.speedment.codegen;
 
+import com.speedment.annotation.Api;
 import java.util.Collection;
 import java.util.Optional;
 import java.util.stream.Stream;
@@ -24,8 +25,10 @@
  * A hook to the generator that can be passed to various stages in the pipeline.
  * Contains multiple methods for generating model-to-model or model-to-text.
  * 
- * @author Emil Forslund
+ * @author Emil Forslund
+ * @since 2.0
  */
+@Api(version = "2.3")
 public interface Generator {
 
  /**
@@ -112,7 +115,7 @@ default <M> Stream<Meta<M, String>> metaOn(M model) {
  * @see Meta
  */
  default <A> Stream<Meta<A, String>> metaOn(Collection<A> models) {
- return models.stream().map(model -> metaOn(model)).flatMap(m -> m);
+ return models.stream().map(this::metaOn).flatMap(m -> m);
  }
 
  /**
@@ -171,7 +174,7 @@ default Optional<String> on(Object model) {
  }
  }
 
- return metaOn(model).map(c -> c.getResult()).findAny();
+ return metaOn(model).map(Meta::getResult).findAny();
  }
 
  /**
@@ -182,7 +185,7 @@ default Optional<String> on(Object model) {
  * @return a stream of meta objects
  */
  default <M> Stream<String> onEach(Collection<M> models) {
- return metaOn(models).map(c -> c.getResult());
+ return metaOn(models).map(Meta::getResult);
  }
 
  /**

src/main/java/com/speedment/codegen/Meta.java

@@ -0,0 +1,135 @@
+/**
+ *
+ * Copyright (c) 2006-2016, Speedment, Inc. All Rights Reserved.
+ *
+ * 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.speedment.codegen;
+
+import com.speedment.annotation.Api;
+
+/**
+ * Meta information about the generation process.
+ * 
+ * @param <A> the model type
+ * @param <B> the result type
+ * @author Emil Forslund
+ * @since 2.0
+ */
+@Api(version = "2.3")
+public interface Meta<A, B> {
+ 
+ /**
+ * The model that was sent to the generator.
+ * @return the model
+ */
+ A getModel();
+ 
+ /**
+ * The result that was produced by the generator.
+ * @return the model
+ */
+ B getResult();
+ 
+ /**
+ * The transform that was used to produce the result.
+ * @return the transform
+ */
+ Transform<A, B> getTransform();
+ 
+ /**
+ * The factory that created the transform.
+ * @return the factory
+ */
+ TransformFactory getFactory();
+ 
+ /**
+ * The render stack that represents which generation processes is waiting
+ * for this result.
+ * 
+ * @return the current render stack
+ */
+ RenderStack getRenderStack();
+ 
+// /**
+// * Meta implementation.
+// * 
+// * @param <A> the model type
+// * @param <B> the result type
+// */
+// class Impl<A, B> implements Meta<A, B> {
+// 
+// private A model;
+// private B result;
+// private Transform<A, B> transform;
+// private TransformFactory factory;
+// private RenderStack stack;
+//
+// Impl() {}
+//
+// @Override
+// public B getResult() {
+// return result;
+// }
+//
+// protected Impl<A, B> setResult(B result) {
+// this.result = result;
+// return this;
+// }
+//
+// @Override
+// public Transform<A, B> getTransform() {
+// return transform;
+// }
+//
+// protected Impl<A, B> setTransform(Transform<A, B> view) {
+// this.transform = view;
+// return this;
+// }
+//
+// @Override
+// public TransformFactory getFactory() {
+// return factory;
+// }
+//
+// protected Impl<A, B> setFactory(TransformFactory factory) {
+// this.factory = factory;
+// return this;
+// }
+//
+// @Override
+// public A getModel() {
+// return model;
+// }
+// 
+// public Impl<A, B> setModel(A model) {
+// this.model = model;
+// return this;
+// }
+//
+// @Override
+// public RenderStack getRenderStack() {
+// return stack;
+// }
+// 
+// public Impl<A, B> setRenderStack(RenderStack stack) {
+// this.stack = stack;
+// return this;
+// }
+//
+// @Override
+// public String toString() {
+// return "Impl{" + "model=" + model + ", result=" + result + ", transform=" + transform + ", factory=" + factory + ", stack=" + stack + '}';
+// }
+// }
+}