com.phloc.commons.name.IHasDisplayName 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 javax.annotation.Nonnull;
/**
* Base interface for objects that have a locale independent display
* name.
* I contract to {@link IHasName} this interface is meant for display names of
* objects (e.g. user names or folder names).
*
* @author Philip Helger
*/
public interface IHasDisplayName
{
/**
* @return The display name of this object. Should never be null.
*/
@Nonnull
String getDisplayName ();
}