statefun-sdk/src/main/java/org/apache/flink/statefun/sdk/FunctionType.java

/*
 * 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.flink.statefun.sdk;

import java.io.Serializable;
import java.util.Objects;

/**
 * This class represents the type of a {@link StatefulFunction}, consisting of a namespace of the
 * function type as well as the type's name.
 *
 * <p>A function's type is part of a function's {@link Address} and serves as integral part of an
 * individual function's identity.
 *
 * @see Address
 */
public final class FunctionType implements Serializable {

  private static final long serialVersionUID = 1;

  private final String namespace;
  private final String type;

  /**
   * Creates a {@link FunctionType}.
   *
   * @param namespace the function type's namepsace.
   * @param type the function type's name.
   */
  public FunctionType(String namespace, String type) {
    this.namespace = Objects.requireNonNull(namespace);
    this.type = Objects.requireNonNull(type);
  }

  /**
   * Returns the namespace of the function type.
   *
   * @return the namespace of the function type.
   */
  public String namespace() {
    return namespace;
  }

  /**
   * Returns the name of the function type.
   *
   * @return the name of the function type.
   */
  public String name() {
    return type;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    FunctionType functionType = (FunctionType) o;
    return namespace.equals(functionType.namespace) && type.equals(functionType.type);
  }

  @Override
  public int hashCode() {
    int hash = 0;
    hash = 37 * hash + namespace.hashCode();
    hash = 37 * hash + type.hashCode();
    return hash;
  }

  @Override
  public String toString() {
    return String.format("FunctionType(%s, %s)", namespace, type);
  }
}