package de.skuzzle.polly.sdk;

import java.util.Date;

/**
 * Manages default number and date conversion to Strings to provide a consistent view
 * of these types.
 * 
 * @author Simon
 * @since zero day
 * @version RC 1.0
 */
public interface FormatManager {

    /**
     * Formats the given number using pollys default NumberFormat.
     * 
     * @param number The number to format.
     * @return The formatted number as a String. 
     */
    public String formatNumber(double number);
    
    
    
    /**
     * Formats the given date using pollys default DateFormat.
     * 
     * @param date The date to format.
     * @return The formatted date as a String.
     */
    public String formatDate(Date date);
    
    
    
    /**
     * Formats the given date using pollys default DateFormat.
     * 
     * @param timestamp The date to format.
     * @return The formatted date as a String.
     */
    public String formatDate(long timestamp);
    
    
    
    /**
     * Formats the given int as a timespan. Note that this method interprets the
     * timespan as seconds.
     * 
     * @param seconds The timespan in seconds.
     * @return The formatted timespan string.
     */
    public String formatTimeSpan(long seconds);



    /**
     * Formats the given int as a timespan.
     * 
     * @param ms The timespan in milliseconds.
     * @return The formatted timespan string.
     * @since 0.9.1
     */
    public abstract String formatTimeSpanMs(long ms);



    /**
     * Formats the given long value into a byte representation 
     * (bytes, kilo bytes, mega bytes).
     * 
     * @param bytes Amount of bytes.
     * @return Formatted byte string.
     */
    public abstract String formatBytes(long bytes);
    
}