Modifier and Type	Class and Description
public static class	MarkupIterator.Chunk
pack-priv static class	MarkupIterator.FieldNumbering Class used locally to assign indexes to the automatically-numbered arguments (see String Formatting section of the Python Standard Library).

Modifier and Type	Field and Description
private final boolean	bytes True if originally given a PyString (so must return PyString not PyUnicode).
private int	index How far along that string we are.
private final String	markup The UTF-16 string from which elements are being returned.
private final MarkupIterator.FieldNumbering	numbering A counter used to auto-number fields when not explicitly numbered in the format.
public static final PyType	TYPE Hides org.python.core.PyObject.TYPE.

Access	Constructor and Description
public	MarkupIterator(PyString markupObject) Constructor used at top-level to enumerate a format.
public	MarkupIterator(MarkupIterator enclosingIterator, String subMarkup) Variant constructor used when formats are nested.

Modifier and Type	Method and Description
public PyObject	__iter__() Overrides org.python.core.PyObject.__iter__. Return an iterator that is used to iterate the element of this sequence.
public PyObject	__iternext__() Overrides org.python.core.PyObject.__iternext__. Return the next element of the sequence that this is an iterator for.
pack-priv final PyObject	formatteriterator___iter__()
pack-priv final PyObject	Returns: `PyTuple` chunk or `null` formatteriterator___iternext__() Return the next "chunk" of the format (or return null if ended).
private int	indexOfFirst(String s, int start, char c1, char c2) Find the first of two characters, or return -1.
public final boolean	Returns: true if originally given a PyString isBytes() If originally given a PyString, string elements in the returned tuples must be PyString not PyUnicode.
public MarkupIterator.Chunk	Returns: the chunk nextChunk() Return the next `Chunk` from the iterator, which is a structure containing parsed elements of the replacement field (if any), and its preceding text.
private void	parseField(MarkupIterator.Chunk destination chunk result, String specifying a replacement field, possibly with nesting fieldMarkup) Parse a "replacement field" consisting of a name, conversion and format specification.
private String	unescapeBraces(String substring)
private PyObject	Returns: object for tuple wrap(String to wrap as a PyObject or null if `defaultValue` should be wrapped. value, String to return or `null` if default return is `None`. defaultValue) Convenience method for populating the return tuple, returning a `PyString` or `PyUnicode` according to the type of the original markup string, or `Py.None` if both arguments are `null`.

bytes	back to summary
private final boolean bytes True if originally given a PyString (so must return PyString not PyUnicode).

index	back to summary
private int index How far along that string we are.

markup	back to summary
private final String markup The UTF-16 string from which elements are being returned.

numbering	back to summary
private final MarkupIterator.FieldNumbering numbering A counter used to auto-number fields when not explicitly numbered in the format.

TYPE	back to summary
public static final PyType TYPE Hides org.python.core.PyObject.TYPE.

MarkupIterator	back to summary
public MarkupIterator(PyString markupObject) Constructor used at top-level to enumerate a format.

MarkupIterator	back to summary
public MarkupIterator(MarkupIterator enclosingIterator, String subMarkup) Variant constructor used when formats are nested.

Method Detail

__iter__	back to summary
public PyObject __iter__() Overrides org.python.core.PyObject.__iter__. Doc from org.python.core.PyObject.__iter__. Return an iterator that is used to iterate the element of this sequence. From version 2.2, this method is the primary protocol for looping over sequences. If a PyObject subclass should support iteration based in the __finditem__() method, it must supply an implementation of __iter__() like this: public PyObject __iter__() { return new PySequenceIter(this); } When iterating over a python sequence from java code, it should be done with code like this: for (PyObject item : seq.asIterable()) { // Do something with item } Annotations @Override

__iter__

public PyObject __iter__()

Overrides org.python.core.PyObject.__iter__.

Doc from org.python.core.PyObject.__iter__.

Return an iterator that is used to iterate the element of this sequence. From version 2.2, this method is the primary protocol for looping over sequences.

If a PyObject subclass should support iteration based in the __finditem__() method, it must supply an implementation of __iter__() like this:

public PyObject __iter__() {
    return new PySequenceIter(this);
}

When iterating over a python sequence from java code, it should be done with code like this:

for (PyObject item : seq.asIterable()) {
    // Do something with item
}

Annotations

@Override

__iternext__	back to summary
public PyObject __iternext__() Overrides org.python.core.PyObject.__iternext__. Doc from org.python.core.PyObject.__iternext__. Return the next element of the sequence that this is an iterator for. Returns null when the end of the sequence is reached. Annotations @Override

__iternext__

back to summary

public PyObject __iternext__()

Overrides org.python.core.PyObject.__iternext__.

Doc from org.python.core.PyObject.__iternext__.

Return the next element of the sequence that this is an iterator for. Returns null when the end of the sequence is reached.

Annotations

@Override

formatteriterator___iter__	back to summary
pack-priv final PyObject formatteriterator___iter__() Annotations @ExposedMethod

formatteriterator___iternext__ back to summary

formatteriterator___iternext__	back to summary
pack-priv final PyObject formatteriterator___iternext__() Return the next "chunk" of the format (or return null if ended). A chunk is a 4-tuple describing the text leading up to the next format field, the field name or number (as a string) for accessing the value, the format specifier such as `"#12x"`, and any conversion that should be applied (the `'s'` or `'r'` codes for `str()` and `repr()`) Elements 1-3 are None if this chunk contains no format specifier. Elements 0-2 are zero-length strings if missing from the format, while element 3 will be None if missing. Returns:PyObject `PyTuple` chunk or `null` Annotations @ExposedMethod

pack-priv final PyObject formatteriterator___iternext__()

Return the next "chunk" of the format (or return null if ended). A chunk is a 4-tuple describing

the text leading up to the next format field,
the field name or number (as a string) for accessing the value,
the format specifier such as "#12x", and
any conversion that should be applied (the 's' or 'r' codes for str() and repr())

Elements 1-3 are None if this chunk contains no format specifier. Elements 0-2 are zero-length strings if missing from the format, while element 3 will be None if missing.

Returns:PyObject

PyTuple chunk or null

Annotations

@ExposedMethod

indexOfFirst	back to summary
private int indexOfFirst(String s, int start, char c1, char c2) Find the first of two characters, or return -1.

isBytes	back to summary
public final boolean isBytes() If originally given a PyString, string elements in the returned tuples must be PyString not PyUnicode. Returns:boolean true if originally given a PyString

isBytes

back to summary

public final boolean isBytes()

If originally given a PyString, string elements in the returned tuples must be PyString not PyUnicode.

Returns:boolean: true if originally given a PyString

nextChunk back to summary

nextChunk	back to summary
public MarkupIterator.Chunk nextChunk() Return the next `Chunk` from the iterator, which is a structure containing parsed elements of the replacement field (if any), and its preceding text. This is the Java equivalent of the tuple returned by `__iternext__()`. This finds use in the implementation of `str.format` and `unicode.format`. Returns:MarkupIterator.Chunk the chunk

public MarkupIterator.Chunk nextChunk()

Return the next Chunk from the iterator, which is a structure containing parsed elements of the replacement field (if any), and its preceding text. This is the Java equivalent of the tuple returned by __iternext__(). This finds use in the implementation of str.format and unicode.format.

Returns:MarkupIterator.Chunk: the chunk

parseField	back to summary
private void parseField(MarkupIterator.Chunk result, String fieldMarkup) Parse a "replacement field" consisting of a name, conversion and format specification. According to the Python Standard Library documentation, a replacement field has the structure: replacement_field ::= "{" [field_name] ["!" conversion] [":" format_spec] "}" field_name ::= arg_name ("." attribute_name \| "[" element_index "]")* arg_name ::= [identifier \| integer] attribute_name ::= identifier element_index ::= integer \| index_string except at this point, we have already discarded the outer braces. Parameters result:MarkupIterator.Chunk destination chunk fieldMarkup:String specifying a replacement field, possibly with nesting

parseField

back to summary

private void parseField(MarkupIterator.Chunk result, String fieldMarkup)

Parse a "replacement field" consisting of a name, conversion and format specification. According to the Python Standard Library documentation, a replacement field has the structure:

replacement_field ::=  "{" [field_name] ["!" conversion] [":" format_spec] "}"
field_name        ::=  arg_name ("." attribute_name | "[" element_index "]")*
arg_name          ::=  [identifier | integer]
attribute_name    ::=  identifier
element_index     ::=  integer | index_string

except at this point, we have already discarded the outer braces.

Parameters

result:MarkupIterator.Chunk: destination chunk
fieldMarkup:String: specifying a replacement field, possibly with nesting

unescapeBraces	back to summary
private String unescapeBraces(String substring)

wrap back to summary

wrap	back to summary
private PyObject wrap(String value, String defaultValue) Convenience method for populating the return tuple, returning a `PyString` or `PyUnicode` according to the type of the original markup string, or `Py.None` if both arguments are `null`. Parameters value:String to wrap as a PyObject or null if `defaultValue` should be wrapped. defaultValue:String to return or `null` if default return is `None`. Returns:PyObject object for tuple

private PyObject wrap(String value, String defaultValue)

Convenience method for populating the return tuple, returning a PyString or PyUnicode according to the type of the original markup string, or Py.None if both arguments are null.

Parameters

value:String: to wrap as a PyObject or null if defaultValue should be wrapped.
defaultValue:String: to return or null if default return is None.

Returns:PyObject

object for tuple

org.python.core.stringlib back to summary

public final Class MarkupIterator.Chunk

Class Inheritance

extends Object

java.lang.Object
org.python.core.stringlib.MarkupIterator.Chunk

Field Summary

Modifier and Type	Field and Description
public String	conversion Conversion to be applied, e.g. `'r'` for `repr()`.
public String	fieldName The field name or number (as a string) for accessing the value.
public String	formatSpec The format specifier such as `"#12x"`.
public boolean	formatSpecNeedsExpanding Signals the `formatSpec` needs expanding recursively.
public String	literalText The text leading up to the next format field.

Constructor Summary

Access	Constructor and Description
public	Chunk()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

conversion	back to summary
public String conversion Conversion to be applied, e.g. `'r'` for `repr()`.

fieldName	back to summary
public String fieldName The field name or number (as a string) for accessing the value.

formatSpec	back to summary
public String formatSpec The format specifier such as `"#12x"`.

formatSpecNeedsExpanding	back to summary
public boolean formatSpecNeedsExpanding Signals the `formatSpec` needs expanding recursively.

literalText	back to summary
public String literalText The text leading up to the next format field.

Constructor Detail

Chunk	back to summary
public Chunk()

org.python.core.stringlib back to summary

pack-priv final Class MarkupIterator.FieldNumbering

Class Inheritance

extends Object

java.lang.Object
org.python.core.stringlib.MarkupIterator.FieldNumbering

Class used locally to assign indexes to the automatically-numbered arguments (see String Formatting section of the Python Standard Library).

Field Summary

Modifier and Type	Field and Description
private int	automaticFieldNumber
private boolean	manualFieldNumberSpecified

Constructor Summary

Access	Constructor and Description
pack-priv	FieldNumbering()

Method Summary

Modifier and Type	Method and Description
pack-priv String	Returns: index as string nextAutomaticFieldNumber() Generate a numeric argument index automatically, or raise an error if already started numbering manually.
pack-priv void	useManualFieldNumbering() Remember we are numbering manually, and raise an error if already started numbering automatically.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

automaticFieldNumber	back to summary
private int automaticFieldNumber

manualFieldNumberSpecified	back to summary
private boolean manualFieldNumberSpecified

Constructor Detail

FieldNumbering	back to summary
pack-priv FieldNumbering()

Method Detail

nextAutomaticFieldNumber	back to summary
pack-priv String nextAutomaticFieldNumber() Generate a numeric argument index automatically, or raise an error if already started numbering manually. Returns:String index as string

nextAutomaticFieldNumber

back to summary

pack-priv String nextAutomaticFieldNumber()

Generate a numeric argument index automatically, or raise an error if already started numbering manually.

Returns:String: index as string

useManualFieldNumbering	back to summary
pack-priv void useManualFieldNumbering() Remember we are numbering manually, and raise an error if already started numbering automatically.

public Class MarkupIterator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class MarkupIterator.Chunk

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

pack-priv final Class MarkupIterator.FieldNumbering

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail