NamingStrategy.java

/*
 * Copyright 2019 Immutables Authors and Contributors
 *
 * Licensed 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.immutables.criteria.backend;

/**
 * Allows to name things like {@code Path}, {@code Container} etc.
 * @param <T> type of the instance to name
 */
public interface NamingStrategy<T> {

  /**
   * Give a generic or specific name to an entity
   * @param toName instance to name
   * @return string representation of {@code toName}
   */
  String name(T toName);

}