Junit

Author: neilellis

src/main/java/com/sillelien/jas/RelProxyException.java

@@ -26,7 +26,6 @@
 public class RelProxyException extends RuntimeException {
  /**
  * Constructs a new exception with the specified message and cause.
- * <p>
  * <p>Parameters are passed to the super constructor.</p>
  *
  * @param message the detail message
@@ -38,7 +37,6 @@ public RelProxyException(@NotNull String message, @NotNull Throwable cause) {
 
  /**
  * Constructs a new exception with the specified message.
- * <p>
  * <p>Parameter is passed to the super constructor.</p>
  *
  * @param message the detail message
@@ -49,7 +47,6 @@ public RelProxyException(@NotNull String message) {
 
  /**
  * Constructs a new exception with the specified cause.
- * <p>
  * <p>Parameter is passed to the super constructor.</p>
  *
  * @param cause the cause

src/main/java/com/sillelien/jas/RelProxyOnReloadListener.java

@@ -24,14 +24,12 @@
 
 /**
  * Is the interface needed to register a class reload listener.
- * <p>
  * <p>An object implementing this interface can optionally be registered on RelProxy to listen when the method of a proxy object has been called
  * and the class of the original object associated has been reloaded (and a new "original" object based on the new class was created to replace it).
  * </p>
  *
  * @author Jose Maria Arranz Santamaria
  * @see JProxyConfig#setRelProxyOnReloadListener(RelProxyOnReloadListener)
- * @see com.sillelien.dollar.relproxy.gproxy.GProxyConfig#setRelProxyOnReloadListener(RelProxyOnReloadListener)
  */
 public interface RelProxyOnReloadListener {
  /**

src/main/java/com/sillelien/jas/jproxy/JProxy.java

@@ -28,29 +28,8 @@
  * @author Jose Maria Arranz Santamaria
  */
 public final class JProxy {
- /**
- * Creates a {@link JProxyConfig} object to be used to configure <code>JProxy</code> and {@link JProxyScriptEngineFactory}.
- *
- * @return a new configuration object.
- * @see #init(JProxyConfig)
- */
- public static JProxyConfig createJProxyConfig() {
- return JProxyDefaultImpl.createJProxyConfig();
- }
-
- /**
- * Initializes <code>JProxy</code> with the provided configuration object.
- *
- * @param config the configuration
- */
- public static void init(@NotNull JProxyConfig config) {
- JProxyDefaultImpl.initStatic((JProxyConfigImpl) config);
- }
-
-
  /**
  * Creates a proxy object using <code>java.lang.reflect.Proxy</code> based on the provided Java object and the class of the implemented Java interface.
- * <p>
  * <p>This method is a simplification for a single interface (the most common case) of {@link #create(Object, Class[])} .</p>
  *
  * @param <T> the interface implemented by the original object and proxy object returned.
@@ -59,18 +38,16 @@ public static void init(@NotNull JProxyConfig config) {
  * @return the <code>java.lang.reflect.Proxy</code> object associated or the original object when <code>GProxy</code> is disabled.
  */
  @Nullable
- public static <T> T create(@NotNull T obj, @NotNull  Class<T> clasz) {
+ public static <T> T create(@NotNull T obj, @NotNull Class<T> clasz) {
  return JProxyDefaultImpl.createStatic(obj, clasz);
  }
 
  /**
  * Creates a proxy object using <code>java.lang.reflect.Proxy</code> based on the provided Java object and the classes of the implemented Java interfaces.
- * <p>
  * <p>If <code>JProxy</code> has been configured and is enabled this method returns a <code>java.lang.reflect.Proxy</code> object implementing instead of
  * the original object provided. Methods called in proxy object are received by <code>JProxy</code> and forwarded to the original object, if source code
  * managed by <code>JProxy</code> has been changed, the class of the original object is reloaded based on the new source and the original object
  * is recreated with the new class and fields are re-set in the new object, then the method is called on the new original object.</p>
- * <p>
  * <p>If <code>JProxy</code> is disabled returns the original object provided with no performance penalty.</p>
  *
  * @param obj the original object to proxy.
@@ -82,6 +59,25 @@ public static Object create(@NotNull Object obj, @NotNull Class<?>[] classes) {
  return JProxyDefaultImpl.createStatic(obj, classes);
  }
 
+ /**
+ * Creates a {@link JProxyConfig} object to be used to configure <code>JProxy</code> and {@link JProxyScriptEngineFactory}.
+ *
+ * @return a new configuration object.
+ * @see #init(JProxyConfig)
+ */
+ public static JProxyConfig createJProxyConfig() {
+ return JProxyDefaultImpl.createJProxyConfig();
+ }
+
+ /**
+ * Initializes <code>JProxy</code> with the provided configuration object.
+ *
+ * @param config the configuration
+ */
+ public static void init(@NotNull JProxyConfig config) {
+ JProxyDefaultImpl.initStatic((JProxyConfigImpl) config);
+ }
+
  /**
  * Informs whether <code>JProxy</code> is configured and enabled.
  *
@@ -100,23 +96,9 @@ public static boolean isRunning() {
  return JProxyDefaultImpl.isRunningStatic();
  }
 
- /**
- * Stops source code periodic change detection.
- * <p>
- * <p>Periodicity of change detection is defined by {@link JProxyConfig#setScanPeriod(long)}</p>
- *
- * @return true if source change detection has been stopped, false if it is already stopped or <code>JProxy</code> is not enabled or initialized.
- * @see #stop()
- */
- public static boolean stop() {
- return JProxyDefaultImpl.stopStatic();
- }
-
  /**
  * Starts source code periodic change detection.
- * <p>
  * <p>Periodicity of change detection is defined by {@link JProxyConfig#setScanPeriod(long)}.</p>
- * <p>
  * <p>By default when <code>JProxy</code> is initialized and enabled.</p>
  *
  * @return true if source change detection has been started again, false if it is already started or cannot start because <code>JProxy</code> is not enabled or initialized or scan period is not positive.
@@ -125,4 +107,15 @@ public static boolean stop() {
  public static boolean start() {
  return JProxyDefaultImpl.startStatic();
  }
+
+ /**
+ * Stops source code periodic change detection.
+ * <p>Periodicity of change detection is defined by {@link JProxyConfig#setScanPeriod(long)}</p>
+ *
+ * @return true if source change detection has been stopped, false if it is already stopped or <code>JProxy</code> is not enabled or initialized.
+ * @see #stop()
+ */
+ public static boolean stop() {
+ return JProxyDefaultImpl.stopStatic();
+ }
 }

src/main/java/com/sillelien/jas/jproxy/JProxyConfig.java

@@ -31,9 +31,30 @@
  * @see JProxyScriptEngine#init(JProxyConfig)
  */
 public interface JProxyConfig {
+ /**
+ * Sets the folder where to save .class files result of recompiling source code changed.
+ * <p>This setting is optional and the folder must be included in Java classpath because the objective is to avoid recompiling.</p>
+ * <p>Be careful when executing several Java scripts in the same time and source code has been changed, some file write collisions may happen.</p>
+ *
+ * @param classFolder the folder where to save .class files. By default is null (not defined, .class files are not saved).
+ * @return this object for flow API use.
+ */
+ @NotNull
+ JProxyConfig setClassFolder(@Nullable String classFolder);
+
+ /**
+ * Sets the compilation options to be provided to the compiler built-in in JDK like <code>JavaCompiler.getTask()</code> method and the same you would provide to javac.
+ * <p>Example of compilation options:</p>
+ * <p><code>Iterable&lt;String&gt; compilationOptions = Arrays.asList(new String[]{"-source","1.6","-target","1.6"});</code></p>
+ *
+ * @param compilationOptions compilation options passed to the internal compiler. By default is null (default compiler settings).
+ * @return this object for flow API use.
+ */
+ @NotNull
+ JProxyConfig setCompilationOptions(@NotNull Iterable<String> compilationOptions);
+
  /**
  * Sets whether automatic detection of source code changes is enabled.
- * <p>
  * <p>If set to false other configuration parameters are ignored, there is no automatic source code change detection/reload and original objects are returned
  * instead of proxies, performance penalty is zero. Setting to false is recommended in production whether source code change detection/reload is not required.</p>
  *
@@ -43,21 +64,13 @@ public interface JProxyConfig {
  @NotNull
  JProxyConfig setEnabled(boolean enabled);
 
- /**
- * Sets the class reload listener.
- *
- * @param relListener the class reload listener. By default is null.
- * @return this object for flow API use.
- */
  @NotNull
- JProxyConfig setRelProxyOnReloadListener(@NotNull RelProxyOnReloadListener relListener);
+ JProxyConfig setImports(@NotNull List<String> imports);
 
  /**
  * Defines the folder root to locate source code Java files.
- * <p>
  * <p>Structure of the source tree must be the same as a JavaSE application, the only difference is shell scripts, shell scripts must be
  * located on the top level of the source tree (default package) and file extension is not required .</p>
- * <p>
  * <p>Setting some input path is required.</p>
  *
  * @param inputPath the folder root to locate source code Java files.
@@ -69,10 +82,8 @@ public interface JProxyConfig {
 
  /**
  * Defines the folder roots to locate source code Java files.
- * <p>
  * <p>Structure of the source tree must be the same as a JavaSE application, the only difference is shell scripts, shell scripts must be
  * located on the top level of the source tree (default package).</p>
- * <p>
  * <p>Setting some input path is required.</p>
  *
  * @param inputPaths the folder roots to locate source code Java files.
@@ -83,31 +94,6 @@ public interface JProxyConfig {
  @NotNull
  JProxyConfig setInputPaths(@NotNull String[] inputPaths);
 
- /**
- * Defines the extra required jars providing the absolute paths to them.
- * <p>
- * <p>In some circunstances RelProxy is not able to find some required classes by the compiler because the jar containing them is not found in spite of existing in classpath,
- * the reason may be due some conflictive configuration of <code>META-INF/MANIFEST.MF</code> of the jar. This problem can be fixed modifying accordingly the <code>META-INF/MANIFEST.MF</code>
- * file, or alternatively providing the paths to the conflictive jars calling to this method, in this case RelProxy will find the required classes searching on them by using brute force
- * avoiding the jar modification (not recommended).
- * </p>
- *
- * @param inputJarPaths the paths of the required extra jars.
- * @return this object for flow API use.
- * @see #setInputPaths(String[])
- */
- @NotNull
- JProxyConfig setRequiredExtraJarPaths(@NotNull String[] inputJarPaths);
-
- /**
- * Registers the listener implementing excluding rules to filter source files not to be part of the hot reloading system in spite of included in input paths.
- *
- * @param listener the listener. By default is null.
- * @return this object for flow API use.
- */
- @NotNull
- JProxyConfig setJProxyInputSourceFileExcludedListener(@Nullable JProxyInputSourceFileExcludedListener listener);
-
  /**
  * Registers the listener for monitoring files being compiled.
  *
@@ -117,49 +103,9 @@ public interface JProxyConfig {
  @NotNull
  JProxyConfig setJProxyCompilerListener(@NotNull JProxyCompilerListener listener);
 
-
- /**
- * Sets the folder where to save .class files result of recompiling source code changed.
- * <p>
- * <p>This setting is optional and the folder must be included in Java classpath because the objective is to avoid recompiling.</p>
- * <p>
- * <p>Be careful when executing several Java scripts in the same time and source code has been changed, some file write collisions may happen.</p>
- *
- * @param classFolder the folder where to save .class files. By default is null (not defined, .class files are not saved).
- * @return this object for flow API use.
- */
- @NotNull
- JProxyConfig setClassFolder(@Nullable String classFolder);
-
- /**
- * Sets the delay between source code change checking.
- * <p>
- * <p>If this value is set to 0 or negative, no periodic source code change detection is executed and only compilation on the fly happens in load time,
- * this is valid for one shot scripts but it has no sense when using proxies.
- *
- * @param scanPeriod the delay between source code change checking.
- * @return this object for flow API use.
- */
- @NotNull
- JProxyConfig setScanPeriod(long scanPeriod);
-
- /**
- * Sets the compilation options to be provided to the compiler built-in in JDK like <code>JavaCompiler.getTask()</code> method and the same you would provide to javac.
- * <p>
- * <p>Example of compilation options:</p>
- * <p><code>Iterable&lt;String&gt; compilationOptions = Arrays.asList(new String[]{"-source","1.6","-target","1.6"});</code></p>
- *
- * @param compilationOptions compilation options passed to the internal compiler. By default is null (default compiler settings).
- * @return this object for flow API use.
- */
- @NotNull
- JProxyConfig setCompilationOptions(@NotNull Iterable<String> compilationOptions);
-
  /**
  * Sets the diagnostic listener to capture compilation errors and warnings thrown by the internal compiler.
- * <p>
  * <p>The following is an example similar to the default behavior when this listener is not specified:</p>
- * <p>
  * <pre>
  * JProxyDiagnosticsListener diagnosticsListener = new JProxyDiagnosticsListener()
  * {
@@ -192,10 +138,49 @@ public interface JProxyConfig {
  @NotNull
  JProxyConfig setJProxyDiagnosticsListener(@NotNull JProxyDiagnosticsListener diagnosticsListener);
 
+ /**
+ * Registers the listener implementing excluding rules to filter source files not to be part of the hot reloading system in spite of included in input paths.
+ *
+ * @param listener the listener. By default is null.
+ * @return this object for flow API use.
+ */
+ @NotNull
+ JProxyConfig setJProxyInputSourceFileExcludedListener(@Nullable JProxyInputSourceFileExcludedListener listener);
+
+ /**
+ * Sets the class reload listener.
+ *
+ * @param relListener the class reload listener. By default is null.
+ * @return this object for flow API use.
+ */
+ @NotNull
+ JProxyConfig setRelProxyOnReloadListener(@NotNull RelProxyOnReloadListener relListener);
 
+ /**
+ * Defines the extra required jars providing the absolute paths to them.
+ * <p>In some circunstances RelProxy is not able to find some required classes by the compiler because the jar containing them is not found in spite of existing in classpath,
+ * the reason may be due some conflictive configuration of <code>META-INF/MANIFEST.MF</code> of the jar. This problem can be fixed modifying accordingly the <code>META-INF/MANIFEST.MF</code>
+ * file, or alternatively providing the paths to the conflictive jars calling to this method, in this case RelProxy will find the required classes searching on them by using brute force
+ * avoiding the jar modification (not recommended).
+ * </p>
+ *
+ * @param inputJarPaths the paths of the required extra jars.
+ * @return this object for flow API use.
+ * @see #setInputPaths(String[])
+ */
  @NotNull
- JProxyConfig setImports(@NotNull List<String> imports);
+ JProxyConfig setRequiredExtraJarPaths(@NotNull String[] inputJarPaths);
 
+ /**
+ * Sets the delay between source code change checking.
+ * <p>If this value is set to 0 or negative, no periodic source code change detection is executed and only compilation on the fly happens in load time,
+ * this is valid for one shot scripts but it has no sense when using proxies.
+ *
+ * @param scanPeriod the delay between source code change checking.
+ * @return this object for flow API use.
+ */
+ @NotNull
+ JProxyConfig setScanPeriod(long scanPeriod);
 
  @NotNull
  JProxyConfig setStaticImports(@NotNull List<String> staticImports);