Packagecom.threerings.util
Classpublic class Joiner



Protected Properties
 PropertyDefined by
  _details : String
Joiner
  _msg : String
Joiner
Public Methods
 MethodDefined by
  
Joiner(message:String = "")
Construct a joiner with the specified message and starting args.
Joiner
  
add(... args):Joiner
Add pairs onto the joiner.
Joiner
  
addArgs(... args):Joiner
Add arguments onto the joiner.
Joiner
  
addArgsArray(args:Array):Joiner
Add arguments, in array form, onto the joiner.
Joiner
  
addFields(obj:Object, fieldNames:Array = null):Joiner
Add public fields, as pairs, to this joiner.
Joiner
  
args(message:String, ... args):String
[static] Return a String in the form "message [arg0, arg1, arg2 ...
Joiner
  
argsArray(message:String, args:Array):String
[static] Return a String in the form "message [arg0, arg1, arg2 ...
Joiner
  
createFor(instance:Object):Joiner
[static] Create a Joiner for depicting some state for the specified object.
Joiner
  
pairs(message:String, ... args):String
[static] Return a String in the form "message [arg0=arg1, arg2=arg3 ...
Joiner
  
pairsArray(message:String, args:Array):String
[static] Return a String in the form "message [arg0=arg1, arg2=arg3 ...
Joiner
  
simpleToString(obj:Object, fieldNames:Array = null):String
[static] Do a simple toString() on an object, printing the public fields.
Joiner
  
toString():String
Turn this joiner into a String.
Joiner
Protected Methods
 MethodDefined by
  
argToString(arg:*):String
[static]
Joiner
  
format(pairs:Boolean, s:String, args:Array):String
[static] Format the args into a String: a0=a1, a2=a3, a4=a5, a6
Joiner
  
output(msg:String, details:String):String
[static] Bracket the details, unless they're empty.
Joiner
Property detail
_detailsproperty
protected var _details:String
_msgproperty 
protected var _msg:String
Constructor detail
Joiner()constructor
public function Joiner(message:String = "")

Construct a joiner with the specified message and starting args.

Parameters
message:String (default = "")
Method detail
add()method
public function add(... args):Joiner

Add pairs onto the joiner.

Parameters
... args

Returns
Joiner
addArgs()method 
public function addArgs(... args):Joiner

Add arguments onto the joiner.

Parameters
... args

Returns
Joiner
addArgsArray()method 
public function addArgsArray(args:Array):Joiner

Add arguments, in array form, onto the joiner.

Parameters
args:Array

Returns
Joiner
addFields()method 
public function addFields(obj:Object, fieldNames:Array = null):Joiner

Add public fields, as pairs, to this joiner.

Parameters
obj:Object
 
fieldNames:Array (default = null)

Returns
Joiner
args()method 
public static function args(message:String, ... args):String

Return a String in the form "message [arg0, arg1, arg2 ... ]" Avoids constructing a Joiner instance. Useful for making messages during Error construction.

Parameters
message:String
 
... args

Returns
String
argsArray()method 
public static function argsArray(message:String, args:Array):String

Return a String in the form "message [arg0, arg1, arg2 ... ]" Avoids constructing a Joiner instance. Useful for making messages during Error construction.

Parameters
message:String
 
args:Array

Returns
String
argToString()method 
protected static function argToString(arg:*):StringParameters
arg:*

Returns
String
createFor()method 
public static function createFor(instance:Object):Joiner

Create a Joiner for depicting some state for the specified object.

Parameters
instance:Object

Returns
Joiner
format()method 
protected static function format(pairs:Boolean, s:String, args:Array):String

Format the args into a String: a0=a1, a2=a3, a4=a5, a6

Parameters
pairs:Boolean
 
s:String
 
args:Array

Returns
String
output()method 
protected static function output(msg:String, details:String):String

Bracket the details, unless they're empty.

Parameters
msg:String
 
details:String

Returns
String
pairs()method 
public static function pairs(message:String, ... args):String

Return a String in the form "message [arg0=arg1, arg2=arg3 ... ]" Avoids constructing a Joiner instance. Useful for making messages during Error construction.

Parameters
message:String
 
... args

Returns
String
pairsArray()method 
public static function pairsArray(message:String, args:Array):String

Return a String in the form "message [arg0=arg1, arg2=arg3 ... ]" Avoids constructing a Joiner instance. Useful for making messages during Error construction.

Parameters
message:String
 
args:Array

Returns
String
simpleToString()method 
public static function simpleToString(obj:Object, fieldNames:Array = null):String

Do a simple toString() on an object, printing the public fields.

Parameters
obj:Object
 
fieldNames:Array (default = null)

Returns
String
toString()method 
public function toString():String

Turn this joiner into a String.

Returns
String