File	Doc	Category	Size	Date	Package
Format.java	API Doc	Java SE 6 API	15711	Tue Jun 10 00:25:52 BST 2008	java.text

Format

• java.lang.Object

Fields Summary
private static final long	serialVersionUID

Constructors Summary
protected Format() Sole constructor. (For invocation by subclass constructors, typically implicit.)

Methods Summary
public java.lang.Object	clone() Creates and returns a copy of this object. return a clone of this instance. try { return super.clone(); } catch (CloneNotSupportedException e) { // will never happen return null; }
java.text.AttributedCharacterIterator	createAttributedCharacterIterator(java.lang.String string, java.text.AttributedCharacterIterator$Attribute key, java.lang.Object value) Returns an AttributedCharacterIterator with the String string and additional key/value pair key, value. param string String to create AttributedCharacterIterator from param key Key for AttributedCharacterIterator param value Value associated with key in AttributedCharacterIterator return AttributedCharacterIterator wrapping args AttributedString as = new AttributedString(string); as.addAttribute(key, value); return as.getIterator();
java.text.AttributedCharacterIterator	createAttributedCharacterIterator(java.text.AttributedCharacterIterator iterator, java.text.AttributedCharacterIterator$Attribute key, java.lang.Object value) Creates an AttributedCharacterIterator with the contents of iterator and the additional attribute key value. param iterator Initial AttributedCharacterIterator to add arg to param key Key for AttributedCharacterIterator param value Value associated with key in AttributedCharacterIterator return AttributedCharacterIterator wrapping args AttributedString as = new AttributedString(iterator); as.addAttribute(key, value); return as.getIterator();
java.text.AttributedCharacterIterator	createAttributedCharacterIterator(java.lang.String s) Creates an AttributedCharacterIterator for the String s. param s String to create AttributedCharacterIterator from return AttributedCharacterIterator wrapping s AttributedString as = new AttributedString(s); return as.getIterator();
java.text.AttributedCharacterIterator	createAttributedCharacterIterator(java.text.AttributedCharacterIterator[] iterators) Creates an AttributedCharacterIterator containg the concatenated contents of the passed in AttributedCharacterIterators. param iterators AttributedCharacterIterators used to create resulting AttributedCharacterIterators return AttributedCharacterIterator wrapping passed in AttributedCharacterIterators AttributedString as = new AttributedString(iterators); return as.getIterator();
public final java.lang.String	format(java.lang.Object obj) Formats an object to produce a string. This is equivalent to {@link #format(Object, StringBuffer, FieldPosition) format}(obj, new StringBuffer(), new FieldPosition(0)).toString(); param obj The object to format return Formatted string. exception IllegalArgumentException if the Format cannot format the given object return format(obj, new StringBuffer(), new FieldPosition(0)).toString();
public abstract java.lang.StringBuffer	format(java.lang.Object obj, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos) Formats an object and appends the resulting text to a given string buffer. If the pos argument identifies a field used by the format, then its indices are set to the beginning and end of the first such field encountered. param obj The object to format param toAppendTo where the text is to be appended param pos A FieldPosition identifying a field in the formatted text return the string buffer passed in as toAppendTo, with formatted text appended exception NullPointerException if toAppendTo or pos is null exception IllegalArgumentException if the Format cannot format the given object
public java.text.AttributedCharacterIterator	formatToCharacterIterator(java.lang.Object obj) Formats an Object producing an AttributedCharacterIterator. You can use the returned AttributedCharacterIterator to build the resulting String, as well as to determine information about the resulting String. Each attribute key of the AttributedCharacterIterator will be of type Field. It is up to each Format implementation to define what the legal values are for each attribute in the AttributedCharacterIterator, but typically the attribute key is also used as the attribute value. The default implementation creates an AttributedCharacterIterator with no attributes. Subclasses that support fields should override this and create an AttributedCharacterIterator with meaningful attributes. exception NullPointerException if obj is null. exception IllegalArgumentException when the Format cannot format the given object. param obj The object to format return AttributedCharacterIterator describing the formatted value. since 1.4 return createAttributedCharacterIterator(format(obj));
public abstract java.lang.Object	parseObject(java.lang.String source, java.text.ParsePosition pos) Parses text from a string to produce an object. The method attempts to parse text starting at the index given by pos. If parsing succeeds, then the index of pos is updated to the index after the last character used (parsing does not necessarily use all characters up to the end of the string), and the parsed object is returned. The updated pos can be used to indicate the starting point for the next call to this method. If an error occurs, then the index of pos is not changed, the error index of pos is set to the index of the character where the error occurred, and null is returned. param source A String, part of which should be parsed. param pos A ParsePosition object with index and error index information as described above. return An Object parsed from the string. In case of error, returns null. exception NullPointerException if pos is null.
public java.lang.Object	parseObject(java.lang.String source) Parses text from the beginning of the given string to produce an object. The method may not use the entire text of the given string. param source A String whose beginning should be parsed. return An Object parsed from the string. exception ParseException if the beginning of the specified string cannot be parsed. ParsePosition pos = new ParsePosition(0); Object result = parseObject(source, pos); if (pos.index == 0) { throw new ParseException("Format.parseObject(String) failed", pos.errorIndex); } return result;