All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.inject.internal.ChildBindingAlreadySetError Maven / Gradle / Ivy

Go to download

The newest version!
package com.google.inject.internal;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.Streams;
import com.google.inject.Key;
import com.google.inject.spi.ErrorDetail;
import java.util.ArrayList;
import java.util.Formatter;
import java.util.List;
import java.util.stream.Collectors;

/**
 * Error reported by Guice when a key is already bound in one or more child injectors or private
 * modules.
 */
final class ChildBindingAlreadySetError extends InternalErrorDetail {
  private final Key key;
  private final ImmutableList existingSources;

  ChildBindingAlreadySetError(Key key, Iterable existingSoruces, List sources) {
    super(
        ErrorId.CHILD_BINDING_ALREADY_SET,
        String.format(
            "Unable to create binding for %s because it was already configured on one or more"
                + " child injectors or private modules.",
            Messages.convert(key)),
        sources,
        null);
    this.key = key;
    // Can't use ImmutableList.toImmutableList here because of b/156759807.
    this.existingSources =
        ImmutableList.copyOf(
            Streams.stream(existingSoruces)
                .map(source -> source == null ? "" : source)
                .collect(Collectors.toList()));
  }

  @Override
  public boolean isMergeable(ErrorDetail otherError) {
    return otherError instanceof ChildBindingAlreadySetError
        && ((ChildBindingAlreadySetError) otherError).key.equals(this.key);
  }

  @Override
  public void formatDetail(List> mergeableErrors, Formatter formatter) {
    formatter.format("\n%s\n", Messages.bold("Bound at:"));
    int index = 1;
    for (Object source : existingSources) {
      formatter.format("%-2s: ", index++);
      if (source.equals("")) {
        formatter.format("as a just-in-time binding\n");
      } else {
        new SourceFormatter(source, formatter, /* omitPreposition= */ true).format();
      }
    }
    List> sourcesList = new ArrayList<>();
    sourcesList.add(getSources());
    mergeableErrors.forEach(error -> sourcesList.add(error.getSources()));

    List> filteredSources =
        sourcesList.stream()
            .map(this::trimSource)
            .filter(list -> !list.isEmpty())
            .collect(Collectors.toList());
    if (!filteredSources.isEmpty()) {
      formatter.format("\n%s\n", Messages.bold("Requested by:"));
      for (int i = 0; i < sourcesList.size(); i++) {
        ErrorFormatter.formatSources(i + 1, sourcesList.get(i), formatter);
      }
    }

    // TODO(b/151482394): Detect if the key was bound in any PrivateModule and suggest exposing the
    // key in those cases.
  }

  @Override
  public ChildBindingAlreadySetError withSources(List newSources) {
    return new ChildBindingAlreadySetError(key, existingSources, newSources);
  }

  /** Omit the key itself in the source list since the information is redundant. */
  private List trimSource(List sources) {
    return sources.stream().filter(source -> !source.equals(this.key)).collect(Collectors.toList());
  }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy