HandledNameConverter (dfxengine API)

java.lang.Object

me.datafox.dfxengine.text.converter.HandledNameConverter

All Implemented Interfaces:: NameConverter<Handled>

public class HandledNameConverter extends Object implements NameConverter<Handled>

A NameConverter that uses Handled.getHandle() followed by Handle.getId() as the singular form. It is not capable of generating the plural form on its own.

Constructor Summary

Constructors

Constructor

Description

HandledNameConverter()
Method Summary

Modifier and Type

Method

Description

String

convert(Handled object)

String

convertPlural(Handled object)

Class<Handled>

getType()

boolean

isPluralCapable()

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

Constructor Details
- HandledNameConverter
  
  public HandledNameConverter()
Method Details
- getType
  
  public Class<Handled> getType()
  
  Specified by:
  
  getType in interface NameConverter<Handled>
  
  Returns:
  
  type of the object that this converter can convert. Always returns Handled.class
- isPluralCapable
  
  public boolean isPluralCapable()
  
  Specified by:
  
  isPluralCapable in interface NameConverter<Handled>
  
  Returns:
  
  true if this converter can also convert to plural form. Always returns false
- convert
  
  public String convert(Handled object)
  
  Specified by:
  
  convert in interface NameConverter<Handled>
  
  Parameters:
  
  object - object to be converted
  
  Returns:
  
  name of the object in singular form
- convertPlural
  
  public String convertPlural(Handled object)
  
  Specified by:
  
  convertPlural in interface NameConverter<Handled>
  
  Parameters:
  
  object - ignored parameter
  
  Returns:
  
  name of the object in singular form, or null if this converter does not support plural form. Always returns null