/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.calcite.buildtools.parser;

import java.util.Objects;

/**
 * Simple container class for a keyword.
 */
public class Keyword {
  public final String keyword;
  public final String filePath;

  public Keyword(String keyword) {
    this(keyword, /*filePath=*/ null);
  }

  /**
   * Creates a {@code Keyword}.
   *
   * @param keyword The keyword string
   * @param filePath The file where this keyword was taken from
   */
  public Keyword(String keyword, String filePath) {
    this.keyword = Objects.requireNonNull(keyword.toUpperCase());
    this.filePath = filePath;
  }

  @Override public int hashCode() {
    // The filePath should not be considered when calculating hashCode.
    return keyword.hashCode();
  }

  @Override public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    } else if (obj == null) {
      return false;
    } else if (!(obj instanceof Keyword)) {
      return false;
    }
    Keyword other = (Keyword) obj;
    // The filePath should not be considered when checking for equality.
    return this.keyword.equals(other.keyword);
  }
}

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.calcite.buildtools.parser;

import java.util.Objects;

/**
 * Simple container class for a keyword.
 */
public class Keyword {
  public final String keyword;
  public final String filePath;

  public Keyword(String keyword) {
    this(keyword, /*filePath=*/ null);
  }

  /**
   * Creates a {@code Keyword}.
   *
   * @param keyword The keyword string
   * @param filePath The file where this keyword was taken from
   */
  public Keyword(String keyword, String filePath) {
    this.keyword = Objects.requireNonNull(keyword.toUpperCase());
    this.filePath = filePath;
  }

  @Override public int hashCode() {
    // The filePath should not be considered when calculating hashCode.
    return keyword.hashCode();
  }

  @Override public boolean equals(Object obj) {
    if (!(obj instanceof Keyword)) {
      return false;
    }
    Keyword other = (Keyword) obj;
    // The filePath should not be considered when checking for equality.
    return this.keyword.equals(other.keyword);
  }
}

Update Keyword custom equals logic (#238)