RBDurationUnitFormatter (Norconex Commons Lang 2.1.0 API)

java.lang.Object
- com.norconex.commons.lang.time.RBDurationUnitFormatter

All Implemented Interfaces:

IDurationUnitFormatter
```
public class RBDurationUnitFormatter
extends Object
implements IDurationUnitFormatter
```
Use localized properties files (ResourceBundle) to get the string representation of duration unit. Each properties file is expected to have the following keys, their plural versions being optional (if a plural unit is spelled the same as singular).

If a key is not found, the toString() version of the unit will be returned. If locale is null, the default locale will be use. If the unit is null, null will be returned.
- year
- years
- month
- months
- week
- weeks
- day
- days
- hour
- hours
- minute
- minutes
- second
- seconds
- millisecond
- milliseconds
Since:

2.0.0

Author:

Pascal Essiembre

Field Summary

Fields
Modifier and Type Field Description

static IDurationUnitFormatter ABBREVIATED

static IDurationUnitFormatter COMPACT

static IDurationUnitFormatter FULL

Constructor Summary

Constructors
Constructor Description

RBDurationUnitFormatter(String baseName)

RBDurationUnitFormatter(String baseName, ClassLoader classLoader)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object other)`
`String`	`format(DurationUnit unit, Locale locale, boolean plural)`	Format a duration unit
`String`	`getBaseName()`
`ClassLoader`	`getClassLoader()`
`protected ResourceBundle`	`getResourceBundle(Locale locale)`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FULL

public static final IDurationUnitFormatter FULL

COMPACT

public static final IDurationUnitFormatter COMPACT

ABBREVIATED

public static final IDurationUnitFormatter ABBREVIATED

Constructor Detail

RBDurationUnitFormatter

public RBDurationUnitFormatter(String baseName)

RBDurationUnitFormatter

public RBDurationUnitFormatter(String baseName,
                               ClassLoader classLoader)

Method Detail
- format
```
public String format(DurationUnit unit,
                     Locale locale,
                     boolean plural)
```
  Description copied from interface: IDurationUnitFormatter
  
  Format a duration unit
  
  Specified by:
  
  format in interface IDurationUnitFormatter
  
  Parameters:
  
  unit - duration unit
  
  locale - locale
  
  plural - true if plural
  
  Returns:
  
  formatted unit
- getClassLoader
```
public ClassLoader getClassLoader()
```
- getBaseName
```
public String getBaseName()
```
- getResourceBundle
```
protected ResourceBundle getResourceBundle(Locale locale)
```
- equals
```
public boolean equals(Object other)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object