desmoj.core.simulator

Class PatternBasedTimeFormatter

java.lang.Object

desmoj.core.simulator.PatternBasedTimeFormatter

All Implemented Interfaces:

TimeFormatter

public class PatternBasedTimeFormatter
extends java.lang.Object
implements TimeFormatter

Use this class to format TimeInstant objects using a java.text.DateFormat object. The PatternBasedTimeFormatter uses a MultiUnitTimeFormatter to format TimeSpans.

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
PatternBasedTimeFormatter() Constructor for a GeneralTimeFormatter.
PatternBasedTimeFormatter(boolean timeZoneIncluded) Constructor for a GeneralTimeFormatter.
PatternBasedTimeFormatter(java.text.DateFormat dateFormat, java.util.concurrent.TimeUnit coarsestUnit, java.util.concurrent.TimeUnit finestUnit) Constructor for a GeneralTimeFormatter.
PatternBasedTimeFormatter(java.lang.String pattern, java.util.concurrent.TimeUnit coarsestUnit, java.util.concurrent.TimeUnit finestUnit) Constructor for a GeneralTimeFormatter.

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

PatternBasedTimeFormatter

public PatternBasedTimeFormatter()

Constructor for a GeneralTimeFormatter. This shortcut constructor uses the pattern "dd.MM.yyyy HH:mm:ss:SSS" (no time zone output). Default Locale is Germany.

PatternBasedTimeFormatter

public PatternBasedTimeFormatter(boolean timeZoneIncluded)

Constructor for a GeneralTimeFormatter. This shortcut constructor uses the pattern "dd.MM.yyyy HH:mm:ss:SSS", followed by a five digits time zone identifier (e.g. "-0800"), if requested. Default Locale is Germany.

Parameters:

timeZoneIncluded - boolean : inclusion of time zone identifiers (true) or not (false).

PatternBasedTimeFormatter

public PatternBasedTimeFormatter(java.text.DateFormat dateFormat,
                                 java.util.concurrent.TimeUnit coarsestUnit,
                                 java.util.concurrent.TimeUnit finestUnit)

Constructor for a GeneralTimeFormatter.

Parameters:

dateFormat - DateFormat : the dateFormat used by this TimeFormatter.

coarsestUnit - TimeUnit: The coarsest Unit for the TimeSpan

finestUnit - TimeUnit: The finest Unit for the TimeSpan

PatternBasedTimeFormatter

public PatternBasedTimeFormatter(java.lang.String pattern,
                                 java.util.concurrent.TimeUnit coarsestUnit,
                                 java.util.concurrent.TimeUnit finestUnit)

Constructor for a GeneralTimeFormatter. Default Locale is Germany.

Parameters:

pattern - String : the pattern used by this UTCTimeFormatter to format TimeSpan and TimeInstant objects. See http://download.oracle.com/javase/1.5.0/docs/api/java/text/SimpleDateFormat.html for a description of the syntax of such patterns.

coarsestUnit - TimeUnit: The coarsest Unit for the TimeSpan

finestUnit - TimeUnit: The finest Unit for the TimeSpan

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.