react4j.processor.StepMethod Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of react4j-processor Show documentation
The Annotation processor
There is a newer version: 0.196
package react4j.processor;

import com.squareup.javapoet.TypeName;
import java.util.Objects;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.type.ExecutableType;

/**
 * Represents a step in the builder. There are a few "intrinsic" methods that are handled by generator
 * but the rest are driven by Input annotation details. The intrinsics are as follows:
 *
 * 
 * name = build: no parameters returns ReactNode and terminates build. This has custom code in implementation.
 * name = child, key = child: This is for single child views and the implementation caches child and returns build().
 * name = children: This is for multi child views and the implementation creates JsArray if null and adds all supplied non-null children to array before invoking build().
 * name = child, key = children: This is for multi child views built one child at a time. The implementation returns if null passed to it, initializes JsArray if null, adds child to array.
 * 
 */
final class StepMethod
{
  /**
   * The name of the input and the corresponding builder method.
   */
  @Nonnull
  private final String _name;
  /**
   * The key under which the input is added into inputs.
   */
  @Nonnull
  private final String _key;
  /**
   * The expected type of the input.
   */
  @Nonnull
  private final TypeName _type;
  @Nullable
  private final InputDescriptor _input;
  /**
   * After this method is called should the builder STAY on the same step, ADVANCE to the next step or TERMINATE builder and call build().
   */
  @Nonnull
  private final StepMethodType _stepMethodType;

  StepMethod( @Nonnull final InputDescriptor input, @Nonnull final StepMethodType stepMethodType )
  {
    this( input.getName(),
          input.getName(),
          TypeName.get( input.getMethodType().getReturnType() ),
          input,
          stepMethodType );
  }

  StepMethod( @Nonnull final String name,
              @Nonnull final String key,
              @Nonnull final TypeName type,
              @Nullable final InputDescriptor input,
              @Nonnull final StepMethodType stepMethodType )
  {
    _name = Objects.requireNonNull( name );
    _key = Objects.requireNonNull( key );
    _type = Objects.requireNonNull( type );
    _input = input;
    _stepMethodType = Objects.requireNonNull( stepMethodType );
  }

  @Nonnull
  String getName()
  {
    return _name;
  }

  @Nonnull
  TypeName getType()
  {
    return _type;
  }

  @Nullable
  InputDescriptor getInput()
  {
    return _input;
  }

  @Nullable
  ExecutableElement getMethod()
  {
    return null != _input ? _input.getMethod() : null;
  }

  @Nullable
  ExecutableType getMethodType()
  {
    return null != _input ? _input.getMethodType() : null;
  }

  @Nonnull
  StepMethodType getStepMethodType()
  {
    return _stepMethodType;
  }

  boolean isBuildIntrinsic()
  {
    return getName().equals( "build" );
  }

  boolean isChildIntrinsic()
  {
    return getName().equals( "child" ) && _key.equals( "child" );
  }

  boolean isChildrenIntrinsic()
  {
    return getName().equals( "children" ) && _key.equals( "children" );
  }

  boolean isChildrenStreamIntrinsic()
  {
    return getName().equals( "children" ) && _key.equals( "*children_stream*" );
  }
}