Add API for static initializers (#386)

* Add api for static initializers

* Update modifier handling in InitializerImpl

As introduced in #387

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Add more tests, extract common code and add equals/hashCode to init.

---------

Co-authored-by: George Gastaldi <gegastaldi@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

api/src/main/java/org/jboss/forge/roaster/model/Initializer.java

@@ -0,0 +1,16 @@
+package org.jboss.forge.roaster.model;
+
+import org.jboss.forge.roaster.Internal;
+import org.jboss.forge.roaster.Origin;
+
+/**
+ * Represents a initializer of a {@link JavaClass}, {@link JavaRecord} or {@link JavaEnum}.
+ */
+public interface Initializer<O extends JavaType<O>, T extends Initializer<O, T>> extends StaticCapable, Internal, Origin<O> {
+
+    /**
+     * Get the inner body of this {@link Initializer}
+     */
+    String getBody();
+
+}

api/src/main/java/org/jboss/forge/roaster/model/InitializerHolder.java

@@ -0,0 +1,21 @@
+package org.jboss.forge.roaster.model;
+
+import java.util.List;
+
+/**
+ * Represents a {@link JavaType} that may define initializers.
+ */
+public interface InitializerHolder<O extends JavaType<O>> {
+
+    /**
+     * Get a {@link List} of all {@link Initializer}s declared by this {@link O} instance, if any; otherwise return an empty
+     * {@link List}
+     */
+    List<? extends Initializer<O, ?>> getInitializers();
+    
+    /**
+     * Return true if this {@link O} instance has the provided {@link Initializer}; otherwise false.
+     */
+    boolean hasInitializer(Initializer<O, ?> initializer);
+    
+}

api/src/main/java/org/jboss/forge/roaster/model/JavaClass.java

@@ -18,6 +18,7 @@
 public interface JavaClass<O extends JavaClass<O>> extends
          JavaType<O>,
          PropertyHolder<O>,
+         InitializerHolder<O>,
          GenericCapable<O>,
          Extendable<O>,
          Abstractable,

api/src/main/java/org/jboss/forge/roaster/model/JavaEnum.java

@@ -17,7 +17,7 @@
  *
  * @author <a href="mailto:lincolnbaxter@gmail.com">Lincoln Baxter, III</a>
  */
-public interface JavaEnum<O extends JavaEnum<O>> extends JavaType<O>, PropertyHolder<O>, TypeHolder<O>, StaticCapable
+public interface JavaEnum<O extends JavaEnum<O>> extends JavaType<O>, PropertyHolder<O>, InitializerHolder<O>, TypeHolder<O>, StaticCapable
 {
    /**
     * Return the {@link EnumConstant} with the given name, or return null if no such constant exists.

api/src/main/java/org/jboss/forge/roaster/model/JavaRecord.java

@@ -11,6 +11,7 @@
 public interface JavaRecord<O extends JavaRecord<O>> extends
          JavaType<O>,
          MethodHolder<O>,
+         InitializerHolder<O>,
          TypeHolder<O>,
          InterfaceCapable
 {

api/src/main/java/org/jboss/forge/roaster/model/source/InitializerHolderSource.java

@@ -0,0 +1,41 @@
+package org.jboss.forge.roaster.model.source;
+
+import java.util.List;
+
+import org.jboss.forge.roaster.model.Initializer;
+import org.jboss.forge.roaster.model.InitializerHolder;
+
+/**
+ * Represents a {@link JavaSource} that may declare initializers.
+ */
+public interface InitializerHolderSource<O extends JavaSource<O>> extends InitializerHolder<O>, MemberHolderSource<O> {
+
+    /**
+     * Get a {@link List} of all {@link InitializerSource}s declared by this {@link O} instance, if any; otherwise return an 
+     * empty {@link List}
+     */
+    @Override
+    List<InitializerSource<O>> getInitializers();
+    
+    /**
+     * Add an uninitialized {@link InitializerSource} declaration to this {@link O} instance. This {@link InitializerSource} will
+     * be a stub until further modified.
+     */
+    InitializerSource<O> addInitializer();
+
+    /**
+     * Add a new {@link InitializerSource} declaration to this {@link O} instance, using the given {@link String} as the
+     * initializer declaration.
+     * <p/>
+     * <strong>For example:</strong><br>
+     * <code>Initializer initializer = javaClass.addInitializer("static { System.out.println(\"Hello\") }")</code>
+     */
+    InitializerSource<O> addInitializer(final String body);
+    
+    /**
+     * Remove the given {@link InitializerSource} declaration from this {@link O} instance, if it exists; otherwise, do
+     * nothing.
+     */
+    O removeInitializer(final Initializer<O, ?> initializer);
+    
+}

api/src/main/java/org/jboss/forge/roaster/model/source/InitializerSource.java

@@ -0,0 +1,16 @@
+package org.jboss.forge.roaster.model.source;
+
+import org.jboss.forge.roaster.model.Initializer;
+
+/**
+ * Represents a Java initializer in source form.
+ */
+public interface InitializerSource<O extends JavaSource<O>> extends Initializer<O, InitializerSource<O>>, 
+    JavaDocCapableSource<InitializerSource<O>>, StaticCapableSource<InitializerSource<O>>, LocationCapable {
+
+    /**
+     * Set the inner body of this {@link Initializer}
+     */
+    InitializerSource<O> setBody(String body);
+
+}

api/src/main/java/org/jboss/forge/roaster/model/source/JavaClassSource.java

@@ -22,6 +22,7 @@ public interface JavaClassSource extends JavaClass<JavaClassSource>,
          GenericCapableSource<JavaClassSource, JavaClassSource>,
          ExtendableSource<JavaClassSource>,
          AbstractableSource<JavaClassSource>,
+         InitializerHolderSource<JavaClassSource>,
          PropertyHolderSource<JavaClassSource>,
          TypeHolderSource<JavaClassSource>,
          FinalCapableSource<JavaClassSource>,

api/src/main/java/org/jboss/forge/roaster/model/source/JavaEnumSource.java

@@ -21,6 +21,7 @@
  */
 public interface JavaEnumSource extends JavaEnum<JavaEnumSource>, JavaSource<JavaEnumSource>,
          InterfaceCapableSource<JavaEnumSource>,
+         InitializerHolderSource<JavaEnumSource>,
          PropertyHolderSource<JavaEnumSource>, TypeHolderSource<JavaEnumSource>, StaticCapableSource<JavaEnumSource>
 {
    /**

api/src/main/java/org/jboss/forge/roaster/model/source/JavaRecordSource.java

@@ -9,6 +9,7 @@ public interface JavaRecordSource extends
          JavaSource<JavaRecordSource>,
          JavaRecord<JavaRecordSource>,
          MethodHolderSource<JavaRecordSource>,
+         InitializerHolderSource<JavaRecordSource>,
          TypeHolderSource<JavaRecordSource>,
          InterfaceCapableSource<JavaRecordSource>
 {