SpecInfo.java

/*
 * JFlex Maven3 plugin
 * Copyright (c) 2007-2017  R��gis D��camps <decamps@users.sf.net>
 * SPDX-License-Identifier: BSD-3-Clause
 */
package jflex.maven.plugin.jflex;

import com.google.common.base.Strings;
import java.io.File;
import java.util.Collections;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import javax.annotation.Nullable;

class SpecInfo {

  /** name of the generated class */
  final String className;

  /** dot-separated package name. Empty string for the default package. */
  final String packageName;

  /** set of files recursively included from the lex spec */
  final Set<File> includedFiles;

  SpecInfo(String className, @Nullable String packageName) {
    this(className, packageName, Collections.emptySet());
  }

  SpecInfo(String className, @Nullable String packageName, Set<File> includedFiles) {
    this.className = className;
    this.packageName = Strings.nullToEmpty(packageName);
    this.includedFiles = new HashSet<>(includedFiles);
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (!(obj instanceof SpecInfo)) {
      return false;
    }
    SpecInfo other = (SpecInfo) obj;
    return Objects.equals(className, other.className)
        && Objects.equals(packageName, other.packageName)
        && Objects.equals(includedFiles, other.includedFiles);
  }

  @Override
  public int hashCode() {
    return Objects.hash(className, packageName, includedFiles);
  }

  /**
   * Returns the (relative) path name of the java source code file that corresponds to the class.
   *
   * <p>For instance, "org.foo.Bar" returns "org/foo/Bar.java"
   *
   * @return Name of the java file.
   */
  String getOutputFilename() {
    // TODO(regisd) Use PackageUtil
    String packageDir = packageName.replace('.', File.separatorChar);
    if (packageDir.length() > 0) {
      packageDir += File.separatorChar;
    }
    return packageDir + className + ".java";
  }
}