Java SourceWriter.beginJavaDocComment方法代码示例

import com.google.gwt.user.rebind.SourceWriter; //导入方法依赖的package包/类
/**
 * Writes code to store and retrieve the current injector interface, if one is
 * bound.
 */
private void outputInterfaceField(GinjectorBindings bindings, SourceWriteUtil sourceWriteUtil,
    SourceWriter writer) {

  // Only the root injector has an interface binding.
  if (bindings.getParent() != null) {
    return;
  }

  Class<?> boundGinjectorInterface = getBoundGinjector(bindings);

  if (boundGinjectorInterface == null) {
    // Sanity-check: if this fails, then we somehow didn't bind the injector
    // interface in the root module (the root module should always generate a
    // binding for the injector).
    errorManager.logError("Injector interface not bound in the root module.");
    return;
  }

  NameGenerator nameGenerator = bindings.getNameGenerator();
  String fieldName = nameGenerator.getGinjectorInterfaceFieldName();
  String getterName = nameGenerator.getGinjectorInterfaceGetterMethodName();

  writer.beginJavaDocComment();
  writer.print("The implementation of " + boundGinjectorInterface);
  writer.endJavaDocComment();
  writer.println("private final %s %s;", boundGinjectorInterface.getCanonicalName(), fieldName);

  sourceWriteUtil.writeMethod(writer,
      String.format("public %s %s()", boundGinjectorInterface.getCanonicalName(), getterName),
      String.format("return %s;", fieldName));
}
 

import com.google.gwt.user.rebind.SourceWriter; //导入方法依赖的package包/类
/**
 * For each fragment in the given {@link FragmentMap}, writes the field that
 * stores it and a getter for that field, and adds code to invoke the
 * fragment's initializers.
 */
private void outputFragments(GinjectorBindings bindings,
    FragmentMap fragments, StringBuilder initializeEagerSingletonsBody,
    StringBuilder initializeStaticInjectionsBody, SourceWriteUtil sourceWriteUtil,
    SourceWriter writer) {
  String implClassName = ginjectorNameGenerator.getClassName(bindings);
  NameGenerator nameGenerator = bindings.getNameGenerator();

  for (FragmentPackageName fragmentPackageName : fragments.getFragmentPackages()) {
    String fragmentCanonicalClassName =
        nameGenerator.getFragmentCanonicalClassName(implClassName,
            fragmentPackageName);
    String fieldName = nameGenerator.getFragmentFieldName(fragmentPackageName);
    String getterName = nameGenerator.getFragmentGetterMethodName(fragmentPackageName);

    // Create the field.
    writer.beginJavaDocComment();
    writer.print("Injector fragment for %s", fragmentPackageName);
    writer.endJavaDocComment();
    writer.print("private %s %s = null;", fragmentCanonicalClassName, fieldName);

    // Write the getter.
    writer.beginJavaDocComment();
    writer.print("Getter for injector fragment for %s", fragmentPackageName);
    writer.endJavaDocComment();
    sourceWriteUtil.writeMethod(writer,
        "public " + fragmentCanonicalClassName + " " + getterName + "()", String.format(
        "if (%2$s == null) {\n"
      + "    %2$s = new %1$s(this);\n"
      + "}\n\n"
      + "return %2$s;", fragmentCanonicalClassName, fieldName));

    if (fragments.get(fragmentPackageName).hasEagerSingletonInitialization()) {
      initializeEagerSingletonsBody.append(getterName + "().initializeEagerSingletons();\n");
    }

    if (fragments.get(fragmentPackageName).hasStaticInjectionInitialization()) {
      initializeStaticInjectionsBody.append(getterName + "().initializeStaticInjections();\n");
    }
  }
}
 

import com.google.gwt.user.rebind.SourceWriter; //导入方法依赖的package包/类
private void writeInterface(TypeLiteral<?> ginjectorInterface, String packageName,
    String implClassName, PrintWriter printWriter, GinjectorBindings rootBindings)
    throws UnableToCompleteException {
  ClassSourceFileComposerFactory composerFactory = new ClassSourceFileComposerFactory(packageName,
      implClassName);

  SourceWriter writer = null;

  try {
    composerFactory.addImplementedInterface(ReflectUtil.getSourceName(ginjectorInterface));

    writer = composerFactory.createSourceWriter(ctx, printWriter);

    String rootInjectorClass = ginjectorNameGenerator.getClassName(rootBindings);
    String rootFieldName = ginjectorNameGenerator.getFieldName(rootBindings);
    writer.beginJavaDocComment();
    writer.print("Top-level injector instance for injector " + rootBindings.getModule() + ".");
    writer.endJavaDocComment();
    writer.println("private final %1$s %2$s = new %1$s(this);", rootInjectorClass, rootFieldName);

    SourceWriteUtil sourceWriteUtil = sourceWriteUtilFactory.create(rootBindings);

    String staticInjectionInitialization = rootBindings.hasStaticInjectionRequestInSubtree()
        ? String.format("%s.initializeStaticInjections();\n", rootFieldName)
        : "";

    String eagerSingletonsInitialization = rootBindings.hasEagerSingletonBindingInSubtree()
        ? String.format("%s.initializeEagerSingletons();\n", rootFieldName)
        : "";

    sourceWriteUtil.writeMethod(writer, "public " + implClassName + "()", String.format(
        // To imitate the behavior of Guice and provide more predictable
        // bootstrap ordering, we initialize the injectors in two phases:
        // static injections first, followed by eager singletons.  Each of
        // these method calls performs all necessary initialization of the
        // given type in all fragments, ensuring that the initializers run in
        // the proper order.
        //
        // See http://code.google.com/p/google-guice/wiki/Bootstrap
        "%s%s", staticInjectionInitialization, eagerSingletonsInitialization));

    outputInterfaceMethods(rootBindings, ginjectorInterface, sourceWriteUtil, writer);
  } catch (NoSourceNameException e) {
    // TODO(schmitt): Collect errors and log list of them.
    logger.log(TreeLogger.Type.ERROR, e.getMessage(), e);
  }

  if (writer != null) {
    writer.commit(logger);
  }
}
 

import com.google.gwt.user.rebind.SourceWriter; //导入方法依赖的package包/类
/**
 * Write a Javadoc comment for a binding, including its context.
 *
 * @param description The description of the binding printed before its
 *     location, such as "Foo bound at: "
 * @param writer The writer to use in displaying the context.
 * @param bindingContext The context of the binding.
 */
public void writeBindingContextJavadoc(SourceWriter writer, Context bindingContext,
    String description) {
  writer.beginJavaDocComment();
  writer.println(description);
  writeBindingContext(writer, bindingContext);
  writer.endJavaDocComment();
}