com.phloc.commons.name.IDisplayNameProvider Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* 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 com.phloc.commons.name;
import java.io.Serializable;
import javax.annotation.Nullable;
/**
* Interface for a handler the provides the locale independent name of an
* object.
*
* @author Philip Helger
* @param
* The data type to retrieve the display name from
*/
public interface IDisplayNameProvider extends Serializable
{
/**
* Get the name of the passed object.
*
* @param aObject
* The object who's name is to be retrieved.
* @return The name of the object. May be null.
*/
@Nullable
String getDisplayName (@Nullable DATATYPE aObject);
}