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:
Serializable, ClassDictInit
Direct Known Subclasses:
PyStringDerived, PyUnicode, SyspathArchive
public class PyString extends PyBaseString implements ClassDictInit
A builtin python string.
See Also:

  • Field Details

  • Constructor Details

    • PyString

      public PyString()

    • PyString

      public PyString(PyType subType, String string)

    • PyString

      public PyString(String string)

    • PyString

      public PyString(char c)

  • Method Details

    • typeSetup

      public static void typeSetup(PyObject dict, PyType.Newstyle marker)

    • classDictInit

      public static void classDictInit(PyObject dict) throws PyIgnoreMethodTag
      Internal use only. Do not call this method explicit.
      Throws:
      PyIgnoreMethodTag

    • safeRepr

      public String safeRepr() throws PyIgnoreMethodTag
      Overrides:
      safeRepr in class PyObject
      Throws:
      PyIgnoreMethodTag

    • __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 a PyObject is to override the standard Java toString method.
      Overrides:
      __str__ in class PyObject

    • __unicode__

      public PyUnicode __unicode__()
      Overrides:
      __unicode__ in class PyObject

    • __len__

      public int __len__()
      Description copied from class: PyObject
      Equivalent to the standard Python __len__ method. Part of the mapping discipline.
      Overrides:
      __len__ in class PyObject
      Returns:
      the length of the object

    • toString

      public String toString()
      Overrides:
      toString in class PyObject

    • internedString

      public 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 a PyObject is to override the standard Java toString method.
      Overrides:
      __repr__ in class PyObject

    • encode_UnicodeEscape

      public static String encode_UnicodeEscape(String str, boolean use_quotes)

    • encode_UnicodeEscape

      public static String encode_UnicodeEscape(String str, boolean use_quotes, boolean unicodeDesignatorPresent)

    • decode_UnicodeEscape

      public static String decode_UnicodeEscape(String str, int start, int end, String errors, boolean unicode)

    • equals

      public boolean equals(Object other)
      Description copied from class: PyObject
      Should almost never be overridden. If overridden, it is the subclasses responsibility to ensure that a.equals(b) == true iff cmp(a,b) == 0
      Overrides:
      equals in class PyObject

    • __cmp__

      public int __cmp__(PyObject other)
      Description copied from class: PyObject
      Equivalent to the standard Python __cmp__ method.
      Overrides:
      __cmp__ in class PyObject
      Parameters:
      other - the object to compare this with.
      Returns:
      -1 if this < 0; 0 if this == o; +1 if this > o; -2 if no comparison is implemented

    • __eq__

      public PyObject __eq__(PyObject other)
      Description copied from class: PyObject
      Equivalent to the standard Python __eq__ method.
      Overrides:
      __eq__ in class PySequence
      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 class PySequence
      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 class PySequence
      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 class PySequence
      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 class PySequence
      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 class PySequence
      Parameters:
      other - the object to compare this with.
      Returns:
      the result of the comparison.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PyObject

    • 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.

    • to_bytes

      public static byte[] to_bytes(String s)
      Returns:
      a byte array with one byte for each char in s. Each byte contains the low-order bits of its corresponding char.

    • from_bytes

      public static String from_bytes(byte[] buf)
      Returns:
      A String with chars corresponding to the bytes in buf

    • from_bytes

      public static String from_bytes(byte[] buf, int off, int len)
      Returns:
      A String of len buff with chars corresponding to buf from off to off + len

    • __tojava__

      public Object __tojava__(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 object Py.NoConversion if this PyObject can not be converted to the desired Java class.
      Overrides:
      __tojava__ in class PySequence
      Parameters:
      c - the Class to convert this PyObject to.

    • createInstance

      public PyString createInstance(String str)

    • __contains__

      public boolean __contains__(PyObject o)
      Description copied from class: PyObject
      Equivalent to the standard Python __contains__ method.
      Overrides:
      __contains__ in class PyObject
      Parameters:
      o - the element to search for in this container.
      Returns:
      the result of the search.

    • __add__

      public PyObject __add__(PyObject generic_other)
      Description copied from class: PyObject
      Equivalent to the standard Python __add__ method
      Overrides:
      __add__ in class PyObject
      Parameters:
      generic_other - the object to perform this binary operation with (the right-hand operand).
      Returns:
      the result of the add, or null if this operation is not defined

    • __reduce__

      public PyObject __reduce__()
      Used for pickling.
      Overrides:
      __reduce__ in class PyObject
      Returns:
      a tuple of (class, tuple)

    • __getnewargs__

      public PyTuple __getnewargs__()
      Overrides:
      __getnewargs__ in class PyObject

    • __mod__

      public PyObject __mod__(PyObject other)
      Description copied from class: PyObject
      Equivalent to the standard Python __mod__ method
      Overrides:
      __mod__ in class PyObject
      Parameters:
      other - the object to perform this binary operation with (the right-hand operand).
      Returns:
      the result of the mod, or null if this operation is not defined

    • str___mod__

      public PyObject str___mod__(PyObject other)

    • __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.
      Overrides:
      __int__ in class PyObject
      Returns:
      an integer corresponding to the value of this object.

    • __long__

      public PyLong __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.
      Overrides:
      __long__ in class PyObject
      Returns:
      a PyLong corresponding to the value of this object.

    • __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.
      Overrides:
      __float__ in class PyObject
      Returns:
      a float corresponding to the value of this object.

    • __pos__

      public PyObject __pos__()
      Description copied from class: PyObject
      Equivalent to the standard Python __pos__ method.
      Overrides:
      __pos__ in class PyObject
      Returns:
      +this.

    • __neg__

      public PyObject __neg__()
      Description copied from class: PyObject
      Equivalent to the standard Python __neg__ method.
      Overrides:
      __neg__ in class PyObject
      Returns:
      -this.

    • __invert__

      public PyObject __invert__()
      Description copied from class: PyObject
      Equivalent to the standard Python __invert__ method.
      Overrides:
      __invert__ in class PyObject
      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 class PyObject
      Returns:
      a complex number corresponding to the value of this object.

    • lower

      public String lower()

    • upper

      public String upper()

    • title

      public String title()

    • swapcase

      public String swapcase()

    • strip

      public String strip()

    • strip

      public String strip(String sep)

    • lstrip

      public String lstrip()

    • lstrip

      public String lstrip(String sep)

    • rstrip

      public String rstrip()

    • rstrip

      public String rstrip(String sep)

    • split

      public PyList split()

    • split

      public PyList split(String sep)

    • split

      public PyList split(String sep, int maxsplit)

    • splitlines

      public PyList splitlines()

    • splitlines

      public PyList splitlines(boolean keepends)

    • index

      public int index(String sub)

    • index

      public int index(String sub, int start)

    • index

      public int index(String sub, int start, int end)

    • rindex

      public int rindex(String sub)

    • rindex

      public int rindex(String sub, int start)

    • rindex

      public int rindex(String sub, int start, int end)

    • count

      public int count(String sub)

    • count

      public int count(String sub, int start)

    • count

      public int count(String sub, int start, int end)

    • find

      public int find(String sub)

    • find

      public int find(String sub, int start)

    • find

      public int find(String sub, int start, int end)

    • rfind

      public int rfind(String sub)

    • rfind

      public int rfind(String sub, int start)

    • rfind

      public int rfind(String sub, int start, int end)

    • atof

      public double atof()

    • atoi

      public int atoi()

    • atoi

      public int atoi(int base)

    • atol

      public PyLong atol()

    • atol

      public PyLong atol(int base)

    • ljust

      public String ljust(int width)

    • rjust

      public String rjust(int width)

    • center

      public String center(int width)

    • zfill

      public String zfill(int width)

    • expandtabs

      public String expandtabs()

    • expandtabs

      public String expandtabs(int tabsize)

    • capitalize

      public String capitalize()

    • join

      public String join(PyObject seq)

    • startswith

      public boolean startswith(String prefix)

    • startswith

      public boolean startswith(String prefix, int offset)

    • startswith

      public boolean startswith(String prefix, int start, int end)

    • endswith

      public boolean endswith(String suffix)

    • endswith

      public boolean endswith(String suffix, int start)

    • endswith

      public boolean endswith(String suffix, int start, int end)

    • translate

      public String translate(String table)

    • translate

      public String translate(String table, String deletechars)

    • translate

      public String translate(PyObject table)

    • 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 String encode()

    • encode

      public String encode(String encoding)

    • encode

      public String encode(String encoding, String errors)

    • decode

      public String decode()

    • decode

      public String decode(String encoding)

    • decode

      public String decode(String encoding, String errors)

    • asString

      public String asString(int index) throws PyObject.ConversionException
      Overrides:
      asString in class PyObject
      Throws:
      PyObject.ConversionException

    • asName

      public String asName(int index) throws PyObject.ConversionException
      Overrides:
      asName in class PyObject
      Throws:
      PyObject.ConversionException