desmoj.core.simulator

Class MultiUnitTimeFormatter

java.lang.Object

desmoj.core.simulator.MultiUnitTimeFormatter

All Implemented Interfaces:

TimeFormatter

public class MultiUnitTimeFormatter
extends java.lang.Object
implements TimeFormatter

Use this class to format TimeSpan and TimeInstant objects like in the following examples: 59 Minutes, 28 Seconds, and 548 Milliseconds could be formatted like O:59:28:548 or 59:28 or 59:28:548:000:000 or 0.59.28.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Felix Klueckmann 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.

Constructor Summary

Constructors

Constructor and Description
MultiUnitTimeFormatter() This is a shortcut constructor for a MultiUnitTimeFormatter.
MultiUnitTimeFormatter(java.util.concurrent.TimeUnit coarsestUnit, java.util.concurrent.TimeUnit finestUnit) This is a constructor for a MultiUnitTimeFormatter. 30 Minutes and 5 Seconds would be 0:30:05:000 if the coarsest TimeUnit is HOURS and the finest TimeUnit is MILLISECONDS.
MultiUnitTimeFormatter(java.util.concurrent.TimeUnit coarsestUnit, java.util.concurrent.TimeUnit finestUnit, char separator) Use this constructor for a MultiUnitTimeFormatter to choose a different separator than the default separator ':'. 30 Minutes and 5 Seconds would be 0:30:05:000 if the coarsest TimeUnit is HOURS and the finest TimeUnit is MILLISECONDS.
MultiUnitTimeFormatter(java.util.concurrent.TimeUnit coarsestUnit, java.util.concurrent.TimeUnit finestUnit, char separator, java.lang.String unitString) Use this constructor for a MultiUnitTimeFormatter to choose a different separator than the default separator ':'. 30 Minutes and 5 Seconds would be 0:30:05:000 if the coarsest TimeUnit is HOURS and the finest TimeUnit is MILLISECONDS.

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildTimeString(TimeInstant instant) Returns the String-Representation of the given TimeInstant.
java.lang.String	buildTimeString(TimeSpan span) Returns the String-Representation of the given TimeSpan.
java.lang.String	getUnit() The units used to format time span and time instants.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiUnitTimeFormatter

public MultiUnitTimeFormatter()

This is a shortcut constructor for a MultiUnitTimeFormatter. The coarsest TimeUnit is HOURS and the finest TimeUnit is MILLISECONDS, so 30 Minutes and 5 Seconds would be 0:30:05:000.

MultiUnitTimeFormatter

public MultiUnitTimeFormatter(java.util.concurrent.TimeUnit coarsestUnit,
                              java.util.concurrent.TimeUnit finestUnit)

This is a constructor for a MultiUnitTimeFormatter. 30 Minutes and 5 Seconds would be 0:30:05:000 if the coarsest TimeUnit is HOURS and the finest TimeUnit is MILLISECONDS. It would be 30:05 if the coarsest TimeUnit is MINUTES and the finest is SECONDS

Parameters:

coarsestUnit - TimeUnit: The coarsest TimeUnit

finestUnit - TimeUnit: The finest TimeUnit

MultiUnitTimeFormatter

public MultiUnitTimeFormatter(java.util.concurrent.TimeUnit coarsestUnit,
                              java.util.concurrent.TimeUnit finestUnit,
                              char separator)

Use this constructor for a MultiUnitTimeFormatter to choose a different separator than the default separator ':'. 30 Minutes and 5 Seconds would be 0:30:05:000 if the coarsest TimeUnit is HOURS and the finest TimeUnit is MILLISECONDS. It would be 30:05 if the coarsest TimeUnit is MINUTES and the finest is SECONDS.

Parameters:

coarsestUnit - TimeUnit: The coarsest TimeUnit

finestUnit - TimeUnit: The finest TimeUnit

separator - char: The separator used to separate the TimeUnits.

MultiUnitTimeFormatter

public MultiUnitTimeFormatter(java.util.concurrent.TimeUnit coarsestUnit,
                              java.util.concurrent.TimeUnit finestUnit,
                              char separator,
                              java.lang.String unitString)

Use this constructor for a MultiUnitTimeFormatter to choose a different separator than the default separator ':'. 30 Minutes and 5 Seconds would be 0:30:05:000 if the coarsest TimeUnit is HOURS and the finest TimeUnit is MILLISECONDS. It would be 30:05 if the coarsest TimeUnit is MINUTES and the finest is SECONDS.

Parameters:

coarsestUnit - TimeUnit: The coarsest TimeUnit

finestUnit - TimeUnit: The finest TimeUnit

separator - char: The separator used to separate the TimeUnits.

unitString - String: The String representing the time units in a custom way (will be built if set to null)

Method Detail

buildTimeString

public java.lang.String buildTimeString(TimeInstant instant)

Returns the String-Representation of the given TimeInstant.

Specified by:

buildTimeString in interface TimeFormatter

Parameters:

instant - TimeInstant: the instant of time to be formatted

Returns:

String: the String representation of the given timeInstant

buildTimeString

public java.lang.String buildTimeString(TimeSpan span)

Returns the String-Representation of the given TimeSpan.

Specified by:

buildTimeString in interface TimeFormatter

Parameters:

span - TimeSpan: the instant of time to be formatted

Returns:

String: the String representation of the given timeSpan.

getUnit

public java.lang.String getUnit()

Description copied from interface: TimeFormatter

The units used to format time span and time instants.

Specified by:

getUnit in interface TimeFormatter

Returns:

String: The description of the smallest time unit or all time units.