com.phloc.commons.format.IFormattedObject 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.format;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.phloc.commons.IHasStringRepresentation;
/**
* Basic interface for special objects having a certain string representation.
*
* @author Philip Helger
*/
public interface IFormattedObject extends IHasStringRepresentation
{
/**
* Get the original value.
*
* @return The unformatted value. May be null.
*/
@Nullable
Object getValue ();
/**
* @return The formatter to be used for formatting this object. Never
* null.
*/
@Nonnull
IFormatter getFormatter ();
/**
* Get the value converted to a string with the specified formatter.
*
* @return the string representation of the value. May be null
* dependent on the semantics of the formatter.
*/
@Nullable
String getAsString ();
}