Package org.python.core
Class PyString
- java.lang.Object
-
- org.python.core.PyObject
-
- org.python.core.PySequence
-
- org.python.core.PyBaseString
-
- org.python.core.PyString
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.CharSequence
,BufferProtocol
- Direct Known Subclasses:
PyShadowString
,PyStringDerived
,PyUnicode
,SyspathArchive
public class PyString extends PyBaseString implements BufferProtocol
A builtin python string.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.python.core.PyObject
PyObject.ConversionException
-
-
Field Summary
Fields Modifier and Type Field Description static PyType
TYPE
-
Fields inherited from class org.python.core.PyObject
gcMonitorGlobal
-
-
Constructor Summary
Constructors Constructor Description PyString()
PyString(char c)
PyString(java.lang.String string)
PyString(PyType subType, java.lang.String string)
Fundamental constructor forPyString
objects when the client provides a JavaString
, necessitating that we range check the characters.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PyObject
__add__(PyObject other)
Equivalent to the standard Python __add__ method.int
__cmp__(PyObject other)
Equivalent to the standard Python __cmp__ method.PyComplex
__complex__()
Equivalent to the standard Python __complex__ method.boolean
__contains__(PyObject o)
Equivalent to the standard Python __contains__ method.PyObject
__eq__(PyObject other)
Equivalent to the standard Python __eq__ method.PyFloat
__float__()
Equivalent to the standard Python __float__ method.PyObject
__format__(PyObject formatSpec)
PyObject
__ge__(PyObject other)
Equivalent to the standard Python __ge__ method.PyTuple
__getnewargs__()
PyObject
__gt__(PyObject other)
Equivalent to the standard Python __gt__ method.PyObject
__int__()
Equivalent to the standard Python __int__ method.PyObject
__invert__()
Equivalent to the standard Python __invert__ method.PyObject
__le__(PyObject other)
Equivalent to the standard Python __le__ method.int
__len__()
Equivalent to the standard Python __len__ method.PyObject
__long__()
Equivalent to the standard Python __long__ method.PyObject
__lt__(PyObject other)
Equivalent to the standard Python __lt__ method.PyObject
__mod__(PyObject other)
Equivalent to the standard Python __mod__ methodPyObject
__mul__(PyObject o)
Equivalent to the standard Python __mul__ method.PyObject
__ne__(PyObject other)
Equivalent to the standard Python __ne__ method.PyObject
__neg__()
Equivalent to the standard Python __neg__ method.PyObject
__pos__()
Equivalent to the standard Python __pos__ method.PyString
__repr__()
Equivalent to the standard Python __repr__ method.PyObject
__rmul__(PyObject o)
Equivalent to the standard Python __rmul__ method.PyString
__str__()
Equivalent to the standard Python __str__ method.java.lang.Object
__tojava__(java.lang.Class<?> c)
Equivalent to the Jython __tojava__ method.PyUnicode
__unicode__()
double
asDouble()
Convert this object into a double.int
asInt()
Convert this object into an int.long
asLong()
Convert this object longo an long.java.lang.String
asName(int index)
java.lang.String
asString()
java.lang.String
asString(int index)
double
atof()
Convert this PyString to a floating-point value according to Python rules.int
atoi()
int
atoi(int base)
PyLong
atol()
PyLong
atol(int base)
java.lang.String
capitalize()
java.lang.String
center(int width)
char
charAt(int index)
int
count(java.lang.String sub)
Equivalent tocount(PyObject)
specialized toString
.int
count(java.lang.String sub, PyObject start)
Equivalent tocount(PyObject, PyObject)
specialized toString
.int
count(java.lang.String sub, PyObject start, PyObject end)
Equivalent tocount(PyObject, PyObject, PyObject)
specialized toString
.int
count(PyObject sub)
Return the number of non-overlapping occurrences of substringsub
.int
count(PyObject sub, PyObject start)
Return the number of non-overlapping occurrences of substringsub
in the range[start:]
.int
count(PyObject sub, PyObject start, PyObject end)
Return the number of non-overlapping occurrences of substringsub
in the range[start:end]
.PyString
createInstance(java.lang.String str)
Create an instance of the same type as this object, from the Java String given as argument.PyObject
decode()
PyObject
decode(java.lang.String encoding)
PyObject
decode(java.lang.String encoding, java.lang.String errors)
static java.lang.String
decode_UnicodeEscape(java.lang.String str, int start, int end, java.lang.String errors, boolean unicode)
java.lang.String
encode()
java.lang.String
encode(java.lang.String encoding)
java.lang.String
encode(java.lang.String encoding, java.lang.String errors)
static java.lang.String
encode_UnicodeEscape(java.lang.String str, boolean use_quotes)
static java.lang.String
encode_UnicodeEscape(java.lang.String str, char quote)
The inner logic of the string __repr__ producing an ASCII representation of the target string, optionally in quotations.boolean
endswith(PyObject suffix)
Equivalent to the Pythonstr.endswith
method, testing whether a string ends with a specified suffix.boolean
endswith(PyObject suffix, PyObject start)
Equivalent to the Pythonstr.endswith
method, testing whether a string ends with a specified suffix, where a sub-range is specified by[start:]
.boolean
endswith(PyObject suffix, PyObject start, PyObject end)
Equivalent to the Pythonstr.endswith
method, testing whether a string ends with a specified suffix, where a sub-range is specified by[start:end]
.java.lang.String
expandtabs()
java.lang.String
expandtabs(int tabsize)
int
find(java.lang.String sub)
Equivalent tofind(PyObject)
specialized toString
.int
find(java.lang.String sub, PyObject start)
Equivalent tofind(PyObject, PyObject)
specialized toString
.int
find(java.lang.String sub, PyObject start, PyObject end)
Equivalent tofind(PyObject, PyObject, PyObject)
specialized toString
.int
find(PyObject sub)
Return the lowest index in the string where substringsub
is found.int
find(PyObject sub, PyObject start)
Return the lowest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:]
.int
find(PyObject sub, PyObject start, PyObject end)
Return the lowest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:end]
.static PyString
fromInterned(java.lang.String interned)
Creates a PyString from an already interned String.PyBuffer
getBuffer(int flags)
Return a read-only buffer view of the contents of the string, treating it as a sequence of unsigned bytes.int
getInt(int i)
java.lang.String
getString()
int
hashCode()
int
index(java.lang.String sub)
Equivalent toindex(PyObject)
specialized toString
.int
index(java.lang.String sub, PyObject start)
Equivalent toindex(PyObject, PyObject)
specialized toString
.int
index(java.lang.String sub, PyObject start, PyObject end)
Equivalent toindex(PyObject, PyObject, PyObject)
specialized toString
.int
index(PyObject sub)
Return the lowest index in the string where substringsub
is found.int
index(PyObject sub, PyObject start)
Return the lowest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:]
.int
index(PyObject sub, PyObject start, PyObject end)
Return the lowest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:end]
.java.lang.String
internedString()
boolean
isalnum()
boolean
isalpha()
boolean
isBasicPlane()
Determine whether the string consists entirely of basic-plane characters.boolean
isdecimal()
boolean
isdigit()
boolean
islower()
boolean
isnumeric()
boolean
isspace()
boolean
istitle()
boolean
isunicode()
boolean
isupper()
PyString
join(PyObject seq)
int
length()
java.lang.String
ljust(int width)
java.lang.String
ljust(int width, java.lang.String padding)
java.lang.String
lower()
java.lang.String
lstrip()
Equivalent of Pythonstr.lstrip()
with no argument, meaning strip whitespace.java.lang.String
lstrip(java.lang.String stripChars)
Equivalent of Pythonstr.lstrip()
.PyObject
lstrip(PyObject stripChars)
Equivalent of Pythonstr.lstrip()
.PyTuple
partition(PyObject sepObj)
Equivalent to Pythonstr.partition()
, splits thePyString
at the first occurrence ofsepObj
returning aPyTuple
containing the part before the separator, the separator itself, and the part after the separator.PyString
replace(PyObject oldPiece, PyObject newPiece)
Equivalent to Python str.replace(old, new), returning a copy of the string with all occurrences of substring old replaced by new.PyString
replace(PyObject oldPiece, PyObject newPiece, int count)
Equivalent to Python str.replace(old, new[, count]), returning a copy of the string with all occurrences of substring old replaced by new.int
rfind(java.lang.String sub)
Equivalent tofind(PyObject)
specialized toString
.int
rfind(java.lang.String sub, PyObject start)
Equivalent tofind(PyObject, PyObject)
specialized toString
.int
rfind(java.lang.String sub, PyObject start, PyObject end)
Equivalent tofind(PyObject, PyObject, PyObject)
specialized toString
.int
rfind(PyObject sub)
Return the highest index in the string where substringsub
is found.int
rfind(PyObject sub, PyObject start)
Return the highest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:]
.int
rfind(PyObject sub, PyObject start, PyObject end)
Return the highest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:end]
.int
rindex(java.lang.String sub)
Equivalent torindex(PyObject)
specialized toString
.int
rindex(java.lang.String sub, PyObject start)
Equivalent torindex(PyObject, PyObject)
specialized toString
.int
rindex(java.lang.String sub, PyObject start, PyObject end)
Equivalent torindex(PyObject, PyObject, PyObject)
specialized toString
.int
rindex(PyObject sub)
Return the highest index in the string where substringsub
is found.int
rindex(PyObject sub, PyObject start)
Return the highest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:]
.int
rindex(PyObject sub, PyObject start, PyObject end)
Return the highest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:end]
.java.lang.String
rjust(int width)
PyTuple
rpartition(PyObject sepObj)
Equivalent to Pythonstr.rpartition()
, splits thePyString
at the last occurrence ofsepObj
returning aPyTuple
containing the part before the separator, the separator itself, and the part after the separator.PyList
rsplit()
Equivalent to Pythonstr.rsplit()
, splitting on runs of whitespace.PyList
rsplit(java.lang.String sep)
Equivalent to Pythonstr.rsplit()
, splitting on a specified string.PyList
rsplit(java.lang.String sep, int maxsplit)
Equivalent to Pythonstr.rsplit()
, splitting on a specified string.PyList
rsplit(PyObject sep)
PyList
rsplit(PyObject sep, int maxsplit)
Asrsplit(PyObject)
but ifmaxsplit
>=0 and there are more feasible splits thanmaxsplit
the last element of the list contains the rest of the string.java.lang.String
rstrip()
Equivalent of Pythonstr.rstrip()
with no argument, meaning strip whitespace.java.lang.String
rstrip(java.lang.String stripChars)
Equivalent of Pythonstr.rstrip()
.PyObject
rstrip(PyObject stripChars)
Equivalent of Pythonstr.rstrip()
.PyList
split()
Equivalent to Pythonstr.split()
, splitting on runs of whitespace.PyList
split(java.lang.String sep)
Equivalent to Pythonstr.split()
, splitting on a specified string.PyList
split(java.lang.String sep, int maxsplit)
Equivalent to Pythonstr.split()
, splitting on a specified string.PyList
split(PyObject sep)
PyList
split(PyObject sep, int maxsplit)
Assplit(PyObject)
but ifmaxsplit
>=0 and there are more feasible splits thanmaxsplit
, the last element of the list contains the rest of the string.PyList
splitlines()
PyList
splitlines(boolean keepends)
boolean
startswith(PyObject prefix)
Equivalent to the Pythonstr.startswith
method testing whether a string starts with a specified prefix.boolean
startswith(PyObject prefix, PyObject start)
Equivalent to the Pythonstr.startswith
method, testing whether a string starts with a specified prefix, where a sub-range is specified by[start:]
.boolean
startswith(PyObject prefix, PyObject start, PyObject end)
Equivalent to the Pythonstr.startswith
method, testing whether a string starts with a specified prefix, where a sub-range is specified by[start:end]
.PyObject
str___mod__(PyObject other)
java.lang.String
strip()
Equivalent of Pythonstr.strip()
with no argument, meaning strip whitespace.java.lang.String
strip(java.lang.String stripChars)
Equivalent of Pythonstr.strip()
.PyObject
strip(PyObject stripChars)
Equivalent of Pythonstr.strip()
.java.lang.CharSequence
subSequence(int start, int end)
java.lang.String
substring(int start, int end)
Return a substring of this object as a Java String.java.lang.String
swapcase()
java.lang.String
title()
byte[]
toBytes()
int[]
toCodePoints()
java.lang.String
toString()
java.lang.String
translate(java.lang.String table)
Equivalent totranslate(PyObject)
specialized toString
.java.lang.String
translate(java.lang.String table, java.lang.String deletechars)
Equivalent totranslate(PyObject, PyObject)
specialized toString
.java.lang.String
translate(PyObject table)
Equivalent to Pythonstr.translate
returning a copy of this string where the characters have been mapped through the translationtable
.java.lang.String
translate(PyObject table, PyObject deletechars)
Equivalent to Pythonstr.translate
returning a copy of this string where all characters (bytes) occurring in the argumentdeletechars
are removed (if it is notnull
), and the remaining characters have been mapped through the translationtable
.java.lang.String
upper()
java.lang.String
zfill(int width)
-
Methods inherited from class org.python.core.PySequence
__delitem__, __delslice__, __finditem__, __finditem__, __getitem__, __getslice__, __iter__, __nonzero__, __setitem__, __setitem__, __setslice__, isMappingType, isNumberType, isSequenceType
-
Methods inherited from class org.python.core.PyObject
__abs__, __and__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __coerce__, __coerce_ex__, __delattr__, __delattr__, __delete__, __delitem__, __delslice__, __dir__, __div__, __divmod__, __ensure_finalizer__, __findattr__, __findattr__, __findattr_ex__, __finditem__, __floordiv__, __get__, __getattr__, __getattr__, __getitem__, __getslice__, __hash__, __hex__, __iadd__, __iand__, __idiv__, __idivmod__, __ifloordiv__, __ilshift__, __imod__, __imul__, __index__, __ior__, __ipow__, __irshift__, __isub__, __iternext__, __itruediv__, __ixor__, __lshift__, __not__, __oct__, __or__, __pow__, __pow__, __radd__, __rand__, __rdiv__, __rdivmod__, __reduce__, __reduce_ex__, __reduce_ex__, __rfloordiv__, __rlshift__, __rmod__, __ror__, __rpow__, __rrshift__, __rshift__, __rsub__, __rtruediv__, __rxor__, __set__, __setattr__, __setattr__, __setitem__, __setslice__, __sub__, __truediv__, __trunc__, __xor__, _add, _and, _callextra, _cmp, _div, _divmod, _doget, _doget, _doset, _eq, _floordiv, _ge, _gt, _iadd, _iand, _idiv, _idivmod, _ifloordiv, _ilshift, _imod, _imul, _in, _ior, _ipow, _irshift, _is, _isnot, _isub, _itruediv, _ixor, _jcall, _jcallexc, _jthrow, _le, _lshift, _lt, _mod, _mul, _ne, _notin, _or, _pow, _rshift, _sub, _truediv, _xor, asIndex, asIndex, asInt, asIterable, asLong, asName, asStringOrNull, asStringOrNull, bit_length, conjugate, delDict, delType, dispatch__init__, equals, fastGetClass, fastGetDict, getDict, getType, implementsDescrDelete, implementsDescrGet, implementsDescrSet, invoke, invoke, invoke, invoke, invoke, invoke, isCallable, isDataDescr, isIndex, isInteger, noAttributeError, object___subclasshook__, readonlyAttributeError, setDict, setType
-
-
-
-
Field Detail
-
TYPE
public static final PyType TYPE
-
-
Constructor Detail
-
PyString
public PyString()
-
PyString
public PyString(PyType subType, java.lang.String string)
Fundamental constructor forPyString
objects when the client provides a JavaString
, necessitating that we range check the characters.- Parameters:
subType
- the actual type being constructedstring
- a Java String to be wrapped
-
PyString
public PyString(java.lang.String string)
-
PyString
public PyString(char c)
-
-
Method Detail
-
getString
public java.lang.String getString()
-
fromInterned
public static PyString fromInterned(java.lang.String interned)
Creates a PyString from an already interned String. Just means it won't be reinterned if used in a place that requires interned Strings.
-
isBasicPlane
public boolean isBasicPlane()
Determine whether the string consists entirely of basic-plane characters. For aPyString
, of course, it is alwaystrue
, but this is useful in cases where either aPyString
or aPyUnicode
is acceptable.- Returns:
- true
-
toCodePoints
public int[] toCodePoints()
-
getBuffer
public PyBuffer getBuffer(int flags)
Return a read-only buffer view of the contents of the string, treating it as a sequence of unsigned bytes. The caller specifies its requirements and navigational capabilities in theflags
argument (see the constants in interfacePyBUF
for an explanation). The method may return the same PyBuffer object to more than one consumer.- Specified by:
getBuffer
in interfaceBufferProtocol
- Parameters:
flags
- consumer requirements- Returns:
- the requested buffer
-
substring
public java.lang.String substring(int start, int end)
Return a substring of this object as a Java String.- Parameters:
start
- the beginning index, inclusive.end
- the ending index, exclusive.- Returns:
- the specified substring.
-
__str__
public PyString __str__()
Description copied from class:PyObject
Equivalent to the standard Python __str__ method. This method should not typically need to be overridden. The easiest way to configure the string representation of aPyObject
is to override the standard JavatoString
method.
-
__unicode__
public PyUnicode __unicode__()
- Overrides:
__unicode__
in classPyObject
-
__len__
public int __len__()
Description copied from class:PyObject
Equivalent to the standard Python __len__ method. Part of the mapping discipline.
-
toString
public java.lang.String toString()
-
internedString
public java.lang.String internedString()
-
__repr__
public PyString __repr__()
Description copied from class:PyObject
Equivalent to the standard Python __repr__ method. This method should not typically need to be overrriden. The easiest way to configure the string representation of aPyObject
is to override the standard JavatoString
method.
-
encode_UnicodeEscape
public static java.lang.String encode_UnicodeEscape(java.lang.String str, boolean use_quotes)
-
encode_UnicodeEscape
public static java.lang.String encode_UnicodeEscape(java.lang.String str, char quote)
The inner logic of the string __repr__ producing an ASCII representation of the target string, optionally in quotations. The caller can determine whether the returned string will be wrapped in quotation marks, and whether Python rules are used to choose them throughquote
.- Parameters:
str
-quoteChar
- '"' or '\'' use that, '?' = let Python choose, 0 or anything = no quotes- Returns:
- encoded string (possibly the same string if unchanged)
-
decode_UnicodeEscape
public static java.lang.String decode_UnicodeEscape(java.lang.String str, int start, int end, java.lang.String errors, boolean unicode)
-
__cmp__
public int __cmp__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __cmp__ method.
-
__eq__
public PyObject __eq__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __eq__ method.- Overrides:
__eq__
in classPySequence
- Parameters:
other
- the object to compare this with.- Returns:
- the result of the comparison.
-
__ne__
public PyObject __ne__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __ne__ method.- Overrides:
__ne__
in classPySequence
- Parameters:
other
- the object to compare this with.- Returns:
- the result of the comparison.
-
__lt__
public PyObject __lt__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __lt__ method.- Overrides:
__lt__
in classPySequence
- Parameters:
other
- the object to compare this with.- Returns:
- the result of the comparison.
-
__le__
public PyObject __le__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __le__ method.- Overrides:
__le__
in classPySequence
- Parameters:
other
- the object to compare this with.- Returns:
- the result of the comparison.
-
__gt__
public PyObject __gt__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __gt__ method.- Overrides:
__gt__
in classPySequence
- Parameters:
other
- the object to compare this with.- Returns:
- the result of the comparison.
-
__ge__
public PyObject __ge__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __ge__ method.- Overrides:
__ge__
in classPySequence
- Parameters:
other
- the object to compare this with.- Returns:
- the result of the comparison.
-
toBytes
public byte[] toBytes()
- Returns:
- a byte array with one byte for each char in this object's underlying String. Each byte contains the low-order bits of its corresponding char.
-
__tojava__
public java.lang.Object __tojava__(java.lang.Class<?> c)
Description copied from class:PyObject
Equivalent to the Jython __tojava__ method. Tries to coerce this object to an instance of the requested Java class. Returns the special objectPy.NoConversion
if thisPyObject
can not be converted to the desired Java class.- Overrides:
__tojava__
in classPySequence
- Parameters:
c
- the Class to convert thisPyObject
to.
-
getInt
public int getInt(int i)
-
createInstance
public PyString createInstance(java.lang.String str)
Create an instance of the same type as this object, from the Java String given as argument. This is to be overridden in a subclass to return its own type.- Parameters:
str
- to wrap- Returns:
-
__contains__
public boolean __contains__(PyObject o)
Description copied from class:PyObject
Equivalent to the standard Python __contains__ method.- Overrides:
__contains__
in classPyObject
- Parameters:
o
- the element to search for in this container.- Returns:
- the result of the search.
-
__mul__
public PyObject __mul__(PyObject o)
Description copied from class:PyObject
Equivalent to the standard Python __mul__ method.
-
__rmul__
public PyObject __rmul__(PyObject o)
Description copied from class:PyObject
Equivalent to the standard Python __rmul__ method.
-
__getnewargs__
public PyTuple __getnewargs__()
- Overrides:
__getnewargs__
in classPyObject
-
__mod__
public PyObject __mod__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __mod__ method
-
__int__
public PyObject __int__()
Description copied from class:PyObject
Equivalent to the standard Python __int__ method. Should only be overridden by numeric objects that can be reasonably coerced into an integer.
-
__long__
public PyObject __long__()
Description copied from class:PyObject
Equivalent to the standard Python __long__ method. Should only be overridden by numeric objects that can be reasonably coerced into a python long.
-
__float__
public PyFloat __float__()
Description copied from class:PyObject
Equivalent to the standard Python __float__ method. Should only be overridden by numeric objects that can be reasonably coerced into a python float.
-
__pos__
public PyObject __pos__()
Description copied from class:PyObject
Equivalent to the standard Python __pos__ method.
-
__neg__
public PyObject __neg__()
Description copied from class:PyObject
Equivalent to the standard Python __neg__ method.
-
__invert__
public PyObject __invert__()
Description copied from class:PyObject
Equivalent to the standard Python __invert__ method.- Overrides:
__invert__
in classPyObject
- Returns:
- ~this.
-
__complex__
public PyComplex __complex__()
Description copied from class:PyObject
Equivalent to the standard Python __complex__ method. Should only be overridden by numeric objects that can be reasonably coerced into a python complex number.- Overrides:
__complex__
in classPyObject
- Returns:
- a complex number corresponding to the value of this object.
-
lower
public java.lang.String lower()
-
upper
public java.lang.String upper()
-
title
public java.lang.String title()
-
swapcase
public java.lang.String swapcase()
-
strip
public java.lang.String strip()
Equivalent of Pythonstr.strip()
with no argument, meaning strip whitespace. Any whitespace byte/character will be discarded from either end of thisstr
.- Returns:
- a new String, stripped of the whitespace characters/bytes
-
strip
public java.lang.String strip(java.lang.String stripChars)
Equivalent of Pythonstr.strip()
.- Parameters:
stripChars
- characters to strip from either end of this str/bytes, or null- Returns:
- a new String, stripped of the specified characters/bytes
-
strip
public PyObject strip(PyObject stripChars)
Equivalent of Pythonstr.strip()
. Any byte/character matching one of those instripChars
will be discarded from either end of thisstr
. IfstripChars == null
, whitespace will be stripped. IfstripChars
is aPyUnicode
, the result will also be aPyUnicode
.- Parameters:
stripChars
- characters to strip from either end of this str/bytes, or null- Returns:
- a new
PyString
(orPyUnicode
), stripped of the specified characters/bytes
-
lstrip
public java.lang.String lstrip()
Equivalent of Pythonstr.lstrip()
with no argument, meaning strip whitespace. Any whitespace byte/character will be discarded from the left of thisstr
.- Returns:
- a new String, stripped of the whitespace characters/bytes
-
lstrip
public java.lang.String lstrip(java.lang.String stripChars)
Equivalent of Pythonstr.lstrip()
.- Parameters:
stripChars
- characters to strip from the left end of this str/bytes, or null- Returns:
- a new String, stripped of the specified characters/bytes
-
lstrip
public PyObject lstrip(PyObject stripChars)
Equivalent of Pythonstr.lstrip()
. Any byte/character matching one of those instripChars
will be discarded from the left end of thisstr
. IfstripChars == null
, whitespace will be stripped. IfstripChars
is aPyUnicode
, the result will also be aPyUnicode
.- Parameters:
stripChars
- characters to strip from the left end of this str/bytes, or null- Returns:
- a new
PyString
(orPyUnicode
), stripped of the specified characters/bytes
-
rstrip
public java.lang.String rstrip()
Equivalent of Pythonstr.rstrip()
with no argument, meaning strip whitespace. Any whitespace byte/character will be discarded from the right end of thisstr
.- Returns:
- a new String, stripped of the whitespace characters/bytes
-
rstrip
public java.lang.String rstrip(java.lang.String stripChars)
Equivalent of Pythonstr.rstrip()
.- Parameters:
stripChars
- characters to strip from either end of this str/bytes, or null- Returns:
- a new String, stripped of the specified characters/bytes
-
rstrip
public PyObject rstrip(PyObject stripChars)
Equivalent of Pythonstr.rstrip()
. Any byte/character matching one of those instripChars
will be discarded from the right end of thisstr
. IfstripChars == null
, whitespace will be stripped. IfstripChars
is aPyUnicode
, the result will also be aPyUnicode
.- Parameters:
stripChars
- characters to strip from the right end of this str/bytes, or null- Returns:
- a new
PyString
(orPyUnicode
), stripped of the specified characters/bytes
-
split
public PyList split()
Equivalent to Pythonstr.split()
, splitting on runs of whitespace.- Returns:
- list(str) result
-
split
public PyList split(java.lang.String sep)
Equivalent to Pythonstr.split()
, splitting on a specified string.- Parameters:
sep
- string to use as separator (ornull
if to split on whitespace)- Returns:
- list(str) result
-
split
public PyList split(java.lang.String sep, int maxsplit)
Equivalent to Pythonstr.split()
, splitting on a specified string.- Parameters:
sep
- string to use as separator (ornull
if to split on whitespace)maxsplit
- maximum number of splits to make (there may bemaxsplit+1
parts).- Returns:
- list(str) result
-
split
public PyList split(PyObject sep)
Equivalent to Pythonstr.split()
returning aPyList
ofPyString
s (orPyUnicode
s). Thestr
will be split at each occurrence ofsep
. Ifsep == null
, whitespace will be used as the criterion. Ifsep
has zero length, a PythonValueError
is raised.- Parameters:
sep
- string to use as separator (ornull
if to split on whitespace)- Returns:
- list(str) result
-
split
public PyList split(PyObject sep, int maxsplit)
Assplit(PyObject)
but ifmaxsplit
>=0 and there are more feasible splits thanmaxsplit
, the last element of the list contains the rest of the string.- Parameters:
sep
- string to use as separator (ornull
if to split on whitespace)maxsplit
- maximum number of splits to make (there may bemaxsplit+1
parts).- Returns:
- list(str) result
-
rsplit
public PyList rsplit()
Equivalent to Pythonstr.rsplit()
, splitting on runs of whitespace.- Returns:
- list(str) result
-
rsplit
public PyList rsplit(java.lang.String sep)
Equivalent to Pythonstr.rsplit()
, splitting on a specified string.- Parameters:
sep
- string to use as separator (ornull
if to split on whitespace)- Returns:
- list(str) result
-
rsplit
public PyList rsplit(java.lang.String sep, int maxsplit)
Equivalent to Pythonstr.rsplit()
, splitting on a specified string.- Parameters:
sep
- string to use as separator (ornull
if to split on whitespace)maxsplit
- maximum number of splits to make (there may bemaxsplit+1
parts).- Returns:
- list(str) result
-
rsplit
public PyList rsplit(PyObject sep)
Equivalent to Pythonstr.rsplit()
returning aPyList
ofPyString
s (orPyUnicode
s). Thestr
will be split at each occurrence ofsep
, working from the right. Ifsep == null
, whitespace will be used as the criterion. Ifsep
has zero length, a PythonValueError
is raised.- Parameters:
sep
- string to use as separator (ornull
if to split on whitespace)- Returns:
- list(str) result
-
rsplit
public PyList rsplit(PyObject sep, int maxsplit)
Asrsplit(PyObject)
but ifmaxsplit
>=0 and there are more feasible splits thanmaxsplit
the last element of the list contains the rest of the string.- Parameters:
sep
- string to use as separator (ornull
if to split on whitespace)maxsplit
- maximum number of splits to make (there may bemaxsplit+1
parts).- Returns:
- list(str) result
-
partition
public PyTuple partition(PyObject sepObj)
Equivalent to Pythonstr.partition()
, splits thePyString
at the first occurrence ofsepObj
returning aPyTuple
containing the part before the separator, the separator itself, and the part after the separator.- Parameters:
sepObj
- str, unicode or object implementingBufferProtocol
- Returns:
- tuple of parts
-
rpartition
public PyTuple rpartition(PyObject sepObj)
Equivalent to Pythonstr.rpartition()
, splits thePyString
at the last occurrence ofsepObj
returning aPyTuple
containing the part before the separator, the separator itself, and the part after the separator.- Parameters:
sepObj
- str, unicode or object implementingBufferProtocol
- Returns:
- tuple of parts
-
splitlines
public PyList splitlines()
-
splitlines
public PyList splitlines(boolean keepends)
-
index
public int index(PyObject sub)
Return the lowest index in the string where substringsub
is found. RaisesValueError
if the substring is not found.- Parameters:
sub
- substring to find.- Returns:
- index of
sub
in this object. - Throws:
PyException(ValueError)
- if not found.
-
index
public int index(PyObject sub, PyObject start) throws PyException
Return the lowest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:]
. RaisesValueError
if the substring is not found.- Parameters:
sub
- substring to find.start
- start of slice.- Returns:
- index of
sub
in this object. - Throws:
PyException(ValueError)
- if not found.PyException
-
index
public int index(PyObject sub, PyObject start, PyObject end) throws PyException
Return the lowest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:end]
. Argumentsstart
andend
are interpreted as in slice notation, with null orPy.None
representing "missing". RaisesValueError
if the substring is not found.- Parameters:
sub
- substring to find.start
- start of slice.end
- end of slice.- Returns:
- index of
sub
in this object. - Throws:
PyException(ValueError)
- if not found.PyException
-
index
public int index(java.lang.String sub)
Equivalent toindex(PyObject)
specialized toString
.
-
index
public int index(java.lang.String sub, PyObject start)
Equivalent toindex(PyObject, PyObject)
specialized toString
.
-
index
public int index(java.lang.String sub, PyObject start, PyObject end)
Equivalent toindex(PyObject, PyObject, PyObject)
specialized toString
.
-
rindex
public int rindex(PyObject sub)
Return the highest index in the string where substringsub
is found. RaisesValueError
if the substring is not found.- Parameters:
sub
- substring to find.- Returns:
- index of
sub
in this object. - Throws:
PyException(ValueError)
- if not found.
-
rindex
public int rindex(PyObject sub, PyObject start) throws PyException
Return the highest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:]
. RaisesValueError
if the substring is not found.- Parameters:
sub
- substring to find.start
- start of slice.- Returns:
- index of
sub
in this object. - Throws:
PyException(ValueError)
- if not found.PyException
-
rindex
public int rindex(PyObject sub, PyObject start, PyObject end) throws PyException
Return the highest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:end]
. Argumentsstart
andend
are interpreted as in slice notation, with null orPy.None
representing "missing". RaisesValueError
if the substring is not found.- Parameters:
sub
- substring to find.start
- start of slice.end
- end of slice.- Returns:
- index of
sub
in this object. - Throws:
PyException(ValueError)
- if not found.PyException
-
rindex
public int rindex(java.lang.String sub)
Equivalent torindex(PyObject)
specialized toString
.
-
rindex
public int rindex(java.lang.String sub, PyObject start)
Equivalent torindex(PyObject, PyObject)
specialized toString
.
-
rindex
public int rindex(java.lang.String sub, PyObject start, PyObject end)
Equivalent torindex(PyObject, PyObject, PyObject)
specialized toString
.
-
count
public int count(PyObject sub)
Return the number of non-overlapping occurrences of substringsub
.- Parameters:
sub
- substring to find.- Returns:
- count of occurrences.
-
count
public int count(PyObject sub, PyObject start)
Return the number of non-overlapping occurrences of substringsub
in the range[start:]
.- Parameters:
sub
- substring to find.start
- start of slice.- Returns:
- count of occurrences.
-
count
public int count(PyObject sub, PyObject start, PyObject end)
Return the number of non-overlapping occurrences of substringsub
in the range[start:end]
. Optional argumentsstart
andend
are interpreted as in slice notation.- Parameters:
sub
- substring to find.start
- start of slice.end
- end of slice.- Returns:
- count of occurrences.
-
count
public int count(java.lang.String sub)
Equivalent tocount(PyObject)
specialized toString
.
-
count
public int count(java.lang.String sub, PyObject start)
Equivalent tocount(PyObject, PyObject)
specialized toString
.
-
count
public int count(java.lang.String sub, PyObject start, PyObject end)
Equivalent tocount(PyObject, PyObject, PyObject)
specialized toString
.
-
find
public int find(PyObject sub)
Return the lowest index in the string where substringsub
is found.- Parameters:
sub
- substring to find.- Returns:
- index of
sub
in this object or -1 if not found.
-
find
public int find(PyObject sub, PyObject start)
Return the lowest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:]
.- Parameters:
sub
- substring to find.start
- start of slice.- Returns:
- index of
sub
in this object or -1 if not found.
-
find
public int find(PyObject sub, PyObject start, PyObject end)
Return the lowest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:end]
. Argumentsstart
andend
are interpreted as in slice notation, with null orPy.None
representing "missing".- Parameters:
sub
- substring to find.start
- start of slice.end
- end of slice.- Returns:
- index of
sub
in this object or -1 if not found.
-
find
public int find(java.lang.String sub)
Equivalent tofind(PyObject)
specialized toString
.
-
find
public int find(java.lang.String sub, PyObject start)
Equivalent tofind(PyObject, PyObject)
specialized toString
.
-
find
public int find(java.lang.String sub, PyObject start, PyObject end)
Equivalent tofind(PyObject, PyObject, PyObject)
specialized toString
.
-
rfind
public int rfind(PyObject sub)
Return the highest index in the string where substringsub
is found.- Parameters:
sub
- substring to find.- Returns:
- index of
sub
in this object or -1 if not found.
-
rfind
public int rfind(PyObject sub, PyObject start)
Return the highest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:]
.- Parameters:
sub
- substring to find.start
- start of slice.- Returns:
- index of
sub
in this object or -1 if not found.
-
rfind
public int rfind(PyObject sub, PyObject start, PyObject end)
Return the highest index in the string where substringsub
is found, such thatsub
is contained in the slices[start:end]
. Argumentsstart
andend
are interpreted as in slice notation, with null orPy.None
representing "missing".- Parameters:
sub
- substring to find.start
- start of slice.end
- end of slice.- Returns:
- index of
sub
in this object or -1 if not found.
-
rfind
public int rfind(java.lang.String sub)
Equivalent tofind(PyObject)
specialized toString
.
-
rfind
public int rfind(java.lang.String sub, PyObject start)
Equivalent tofind(PyObject, PyObject)
specialized toString
.
-
rfind
public int rfind(java.lang.String sub, PyObject start, PyObject end)
Equivalent tofind(PyObject, PyObject, PyObject)
specialized toString
.
-
atof
public double atof()
Convert this PyString to a floating-point value according to Python rules.- Returns:
- the value
-
atoi
public int atoi()
-
atoi
public int atoi(int base)
-
atol
public PyLong atol()
-
atol
public PyLong atol(int base)
-
ljust
public java.lang.String ljust(int width)
-
ljust
public java.lang.String ljust(int width, java.lang.String padding)
-
rjust
public java.lang.String rjust(int width)
-
center
public java.lang.String center(int width)
-
zfill
public java.lang.String zfill(int width)
-
expandtabs
public java.lang.String expandtabs()
-
expandtabs
public java.lang.String expandtabs(int tabsize)
-
capitalize
public java.lang.String capitalize()
-
replace
public PyString replace(PyObject oldPiece, PyObject newPiece)
Equivalent to Python str.replace(old, new), returning a copy of the string with all occurrences of substring old replaced by new. If either argument is aPyUnicode
(or this object is), the result will be aPyUnicode
.- Parameters:
oldPiece
- to replace where found.newPiece
- replacement text.- Returns:
- PyString (or PyUnicode if any string is one), this string after replacements.
-
replace
public PyString replace(PyObject oldPiece, PyObject newPiece, int count)
Equivalent to Python str.replace(old, new[, count]), returning a copy of the string with all occurrences of substring old replaced by new. If argumentcount
is nonnegative, only the firstcount
occurrences are replaced. If either argument is aPyUnicode
(or this object is), the result will be aPyUnicode
.- Parameters:
oldPiece
- to replace where found.newPiece
- replacement text.count
- maximum number of replacements to make, or -1 meaning all of them.- Returns:
- PyString (or PyUnicode if any string is one), this string after replacements.
-
startswith
public boolean startswith(PyObject prefix)
Equivalent to the Pythonstr.startswith
method testing whether a string starts with a specified prefix.prefix
can also be a tuple of prefixes to look for.- Parameters:
prefix
- string to check for (or aPyTuple
of them).- Returns:
true
if this string slice starts with a specified prefix, otherwisefalse
.
-
startswith
public boolean startswith(PyObject prefix, PyObject start)
Equivalent to the Pythonstr.startswith
method, testing whether a string starts with a specified prefix, where a sub-range is specified by[start:]
.start
is interpreted as in slice notation, with null orPy.None
representing "missing".prefix
can also be a tuple of prefixes to look for.- Parameters:
prefix
- string to check for (or aPyTuple
of them).start
- start of slice.- Returns:
true
if this string slice starts with a specified prefix, otherwisefalse
.
-
startswith
public boolean startswith(PyObject prefix, PyObject start, PyObject end)
Equivalent to the Pythonstr.startswith
method, testing whether a string starts with a specified prefix, where a sub-range is specified by[start:end]
. Argumentsstart
andend
are interpreted as in slice notation, with null orPy.None
representing "missing".prefix
can also be a tuple of prefixes to look for.- Parameters:
prefix
- string to check for (or aPyTuple
of them).start
- start of slice.end
- end of slice.- Returns:
true
if this string slice starts with a specified prefix, otherwisefalse
.
-
endswith
public boolean endswith(PyObject suffix)
Equivalent to the Pythonstr.endswith
method, testing whether a string ends with a specified suffix.suffix
can also be a tuple of suffixes to look for.- Parameters:
suffix
- string to check for (or aPyTuple
of them).- Returns:
true
if this string slice ends with a specified suffix, otherwisefalse
.
-
endswith
public boolean endswith(PyObject suffix, PyObject start)
Equivalent to the Pythonstr.endswith
method, testing whether a string ends with a specified suffix, where a sub-range is specified by[start:]
.start
is interpreted as in slice notation, with null orPy.None
representing "missing".suffix
can also be a tuple of suffixes to look for.- Parameters:
suffix
- string to check for (or aPyTuple
of them).start
- start of slice.- Returns:
true
if this string slice ends with a specified suffix, otherwisefalse
.
-
endswith
public boolean endswith(PyObject suffix, PyObject start, PyObject end)
Equivalent to the Pythonstr.endswith
method, testing whether a string ends with a specified suffix, where a sub-range is specified by[start:end]
. Argumentsstart
andend
are interpreted as in slice notation, with null orPy.None
representing "missing".suffix
can also be a tuple of suffixes to look for.- Parameters:
suffix
- string to check for (or aPyTuple
of them).start
- start of slice.end
- end of slice.- Returns:
true
if this string slice ends with a specified suffix, otherwisefalse
.
-
translate
public java.lang.String translate(PyObject table)
Equivalent to Pythonstr.translate
returning a copy of this string where the characters have been mapped through the translationtable
.table
must be equivalent to a string of length 256 (if it is notnull
).- Parameters:
table
- of character (byte) translations (ornull
)- Returns:
- transformed byte string
-
translate
public java.lang.String translate(PyObject table, PyObject deletechars)
Equivalent to Pythonstr.translate
returning a copy of this string where all characters (bytes) occurring in the argumentdeletechars
are removed (if it is notnull
), and the remaining characters have been mapped through the translationtable
.table
must be equivalent to a string of length 256 (if it is notnull
).- Parameters:
table
- of character (byte) translations (ornull
)deletechars
- set of characters to remove (ornull
)- Returns:
- transformed byte string
-
translate
public java.lang.String translate(java.lang.String table)
Equivalent totranslate(PyObject)
specialized toString
.
-
translate
public java.lang.String translate(java.lang.String table, java.lang.String deletechars)
Equivalent totranslate(PyObject, PyObject)
specialized toString
.
-
islower
public boolean islower()
-
isupper
public boolean isupper()
-
isalpha
public boolean isalpha()
-
isalnum
public boolean isalnum()
-
isdecimal
public boolean isdecimal()
-
isdigit
public boolean isdigit()
-
isnumeric
public boolean isnumeric()
-
istitle
public boolean istitle()
-
isspace
public boolean isspace()
-
isunicode
public boolean isunicode()
-
encode
public java.lang.String encode()
-
encode
public java.lang.String encode(java.lang.String encoding)
-
encode
public java.lang.String encode(java.lang.String encoding, java.lang.String errors)
-
decode
public PyObject decode()
-
decode
public PyObject decode(java.lang.String encoding)
-
decode
public PyObject decode(java.lang.String encoding, java.lang.String errors)
-
__format__
public PyObject __format__(PyObject formatSpec)
- Overrides:
__format__
in classPyObject
-
asString
public java.lang.String asString(int index) throws PyObject.ConversionException
- Overrides:
asString
in classPyObject
- Throws:
PyObject.ConversionException
-
asInt
public int asInt()
Description copied from class:PyObject
Convert this object into an int. Throws a PyException on failure.
-
asLong
public long asLong()
Description copied from class:PyObject
Convert this object longo an long. Throws a PyException on failure.
-
asDouble
public double asDouble()
Description copied from class:PyObject
Convert this object into a double. Throws a PyException on failure.
-
asName
public java.lang.String asName(int index) throws PyObject.ConversionException
- Overrides:
asName
in classPyObject
- Throws:
PyObject.ConversionException
-
charAt
public char charAt(int index)
- Specified by:
charAt
in interfacejava.lang.CharSequence
- Overrides:
charAt
in classPyBaseString
-
length
public int length()
- Specified by:
length
in interfacejava.lang.CharSequence
- Overrides:
length
in classPyBaseString
-
subSequence
public java.lang.CharSequence subSequence(int start, int end)
- Specified by:
subSequence
in interfacejava.lang.CharSequence
- Overrides:
subSequence
in classPyBaseString
-
-