JRuby Base 10.0.0.0 · org.jruby.util.RegexpOptions · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private boolean	encodingNone
private boolean	extended
private boolean	fixed
private boolean	ignorecase
private boolean	java
private KCode	kcode
private boolean	kcodeDefault
private boolean	literal
private boolean	multiline
public static final RegexpOptions	NULL_OPTIONS
private boolean	once
private static final ByteList	WINDOWS31J

Access	Constructor and Description
public	RegexpOptions()
public	RegexpOptions(KCode kcode, boolean isKCodeDefault)

Method Summary

Modifier and Type	Method and Description
public RegexpOptions	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static RegexpOptions	fromByteList(Ruby runtime, ByteList string)
public static RegexpOptions	fromByteList(ThreadContext context, ByteList string)
public static RegexpOptions	fromEmbeddedOptions(int embeddedOptions)
public static RegexpOptions	fromJoniOptions(int joniOptions)
private KCode	getExplicitKCode()
public KCode	getKCode()
public String	getKCodeName()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEmbeddable()
public boolean	isEncodingNone()
public boolean	isExtended()
public boolean	isFixed()
public boolean	isIgnorecase()
public boolean	isJava()
public boolean	isKcodeDefault() Whether the kcode associated with this regexp is implicit (aka default) or is specified explicitly (via 'nesu' syntax postscript or flags to Regexp.new.
public boolean	isLiteral()
public boolean	isMultiline()
public boolean	isOnce()
public static RegexpOptions	newRegexpOptions(String validOptions)
public void	setEncodingNone(boolean encodingNone)
public void	setExplicitKCode(KCode to be set kcode) This regexp has an explicit encoding flag or 'nesu' letter associated with it.
public void	setExtended(boolean extended)
public void	setFixed(boolean fixed)
public void	setIgnorecase(boolean ignorecase)
public void	setJava(boolean java)
public void	setLiteral(boolean literal)
public void	setMultiline(boolean multiline)
public void	setOnce(boolean once)
public Encoding	Returns: null if no explicit encoding is specified. setup(Ruby runtime) Calculate the encoding based on kcode option set via 'nesu'.
public int	toEmbeddedOptions() This int value can be used by compiler or any place where we want an integer representation of the state of this object.
public int	toJoniOptions() This int value is meant to only be used when dealing directly with the joni regular expression library.
public int	toOptions() This int value is used by Regex#options
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public RegexpOptions	withoutOnce()

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

encodingNone	back to summary
private boolean encodingNone

extended	back to summary
private boolean extended

fixed	back to summary
private boolean fixed

ignorecase	back to summary
private boolean ignorecase

java	back to summary
private boolean java

kcode	back to summary
private KCode kcode

kcodeDefault	back to summary
private boolean kcodeDefault

literal	back to summary
private boolean literal

multiline	back to summary
private boolean multiline

NULL_OPTIONS	back to summary
public static final RegexpOptions NULL_OPTIONS

once	back to summary
private boolean once

WINDOWS31J	back to summary
private static final ByteList WINDOWS31J

RegexpOptions	back to summary
public RegexpOptions()

RegexpOptions	back to summary
public RegexpOptions(KCode kcode, boolean isKCodeDefault)

Method Detail

clone back to summary

clone	back to summary
public RegexpOptions clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:RegexpOptions a clone of this instance. Annotations @Override

public RegexpOptions clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:RegexpOptions

a clone of this instance.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

fromByteList	back to summary
public static RegexpOptions fromByteList(Ruby runtime, ByteList string)

fromByteList	back to summary
public static RegexpOptions fromByteList(ThreadContext context, ByteList string)

fromEmbeddedOptions	back to summary
public static RegexpOptions fromEmbeddedOptions(int embeddedOptions)

fromJoniOptions	back to summary
public static RegexpOptions fromJoniOptions(int joniOptions)

getExplicitKCode	back to summary
private KCode getExplicitKCode()

getKCode	back to summary
public KCode getKCode()

getKCodeName	back to summary
public String getKCodeName()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isEmbeddable	back to summary
public boolean isEmbeddable()

isEncodingNone	back to summary
public boolean isEncodingNone()

isExtended	back to summary
public boolean isExtended()

isFixed	back to summary
public boolean isFixed()

isIgnorecase	back to summary
public boolean isIgnorecase()

isJava	back to summary
public boolean isJava()

isKcodeDefault	back to summary
public boolean isKcodeDefault() Whether the kcode associated with this regexp is implicit (aka default) or is specified explicitly (via 'nesu' syntax postscript or flags to Regexp.new.

isLiteral	back to summary
public boolean isLiteral()

isMultiline	back to summary
public boolean isMultiline()

isOnce	back to summary
public boolean isOnce()

newRegexpOptions	back to summary
public static RegexpOptions newRegexpOptions(String validOptions)

setEncodingNone	back to summary
public void setEncodingNone(boolean encodingNone)

setExplicitKCode	back to summary
public void setExplicitKCode(KCode kcode) This regexp has an explicit encoding flag or 'nesu' letter associated with it. Parameters kcode:KCode to be set

setExplicitKCode

back to summary

public void setExplicitKCode(KCode kcode)

This regexp has an explicit encoding flag or 'nesu' letter associated with it.

Parameters

kcode:KCode: to be set

setExtended	back to summary
public void setExtended(boolean extended)

setFixed	back to summary
public void setFixed(boolean fixed)

setIgnorecase	back to summary
public void setIgnorecase(boolean ignorecase)

setJava	back to summary
public void setJava(boolean java)

setLiteral	back to summary
public void setLiteral(boolean literal)

setMultiline	back to summary
public void setMultiline(boolean multiline)

setOnce	back to summary
public void setOnce(boolean once)

setup	back to summary
public Encoding setup(Ruby runtime) Calculate the encoding based on kcode option set via 'nesu'. Also as side-effects: 1.set whether this marks the soon to be made regexp as 'fixed'. 2.kcode.none will set 'none' option Returns:Encoding null if no explicit encoding is specified.

setup

back to summary

public Encoding setup(Ruby runtime)

Calculate the encoding based on kcode option set via 'nesu'. Also as side-effects: 1.set whether this marks the soon to be made regexp as 'fixed'. 2.kcode.none will set 'none' option

Returns:Encoding: null if no explicit encoding is specified.

toEmbeddedOptions	back to summary
public int toEmbeddedOptions() This int value can be used by compiler or any place where we want an integer representation of the state of this object. Note This is for full representation of state in the JIT. It is not to be confused with state of marshalled regexp data.

toJoniOptions	back to summary
public int toJoniOptions() This int value is meant to only be used when dealing directly with the joni regular expression library. It differs from embeddedOptions in that it only contains bit values which Joni cares about.

toOptions	back to summary
public int toOptions() This int value is used by Regex#options

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

withoutOnce	back to summary
public RegexpOptions withoutOnce()

public Class RegexpOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail