Top Description Fields Constructors Methods
org.jruby.ir.operands

public Class FrozenString

extends ImmutableLiteral<RubyString>
implements Stringable, StringLiteral
Class Inheritance
All Implemented Interfaces
org.jruby.ir.operands.StringLiteral, org.jruby.ir.operands.Stringable
Imports
org.jruby.RubyString, .RubySymbol, org.jruby.ir.IRVisitor, org.jruby.ir.persistence.IRReaderDecoder, .IRWriterEncoder, org.jruby.ir.runtime.IRRuntimeHelpers, org.jruby.ir.transformations.inlining.CloneInfo, org.jruby.runtime.Helpers, .ThreadContext, org.jruby.util.ByteList, .StringSupport, java.nio.charset.UnsupportedCharsetException, java.util.List

Represents a frozen string value.

Field Summary

Modifier and TypeField and Description
public final ByteList
public final int
public final String
public final int
public String

Constructor Summary

AccessConstructor and Description
public
FrozenString(ByteList bytelist, int coderange, String file, int line)

Used by persistence and by .freeze optimization

public
public
FrozenString(String s)

IRBuild.buildGetDefinition returns a frozen string and this is for all intern'd Java strings.

protected

Method Summary

Modifier and TypeMethod and Description
public Operand
public RubyString
createCacheObject(ThreadContext context)

Implements abstract org.jruby.ir.operands.ImmutableLiteral.createCacheObject.

Implementing class is responsible for constructing the cached value.

public static FrozenString
public void
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 ByteList
public int
public String
public int
public OperandType
public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
hasKnownValue()

Overrides org.jruby.ir.operands.ImmutableLiteral.hasKnownValue.

Do we know the value of this operand at compile-time?

private static String
public boolean
isCached()

Overrides org.jruby.ir.operands.ImmutableLiteral.isCached.

Has this object already been cached?

public boolean
isTruthyImmediate()

Overrides org.jruby.ir.operands.Operand.isTruthyImmediate.

Returns true if this is an immediate value that will always be considered truthy (true, numbers, etc)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
Inherited from org.jruby.ir.operands.ImmutableLiteral:
addUsedVariablescachedObjectcanCopyPropagateretrieve

Field Detail

bytelistback to summary
public final ByteList bytelist
coderangeback to summary
public final int coderange
fileback to summary
public final String file
lineback to summary
public final int line
stringback to summary
public String string

Constructor Detail

FrozenStringback to summary
public FrozenString(ByteList bytelist, int coderange, String file, int line)

Used by persistence and by .freeze optimization

FrozenStringback to summary
public FrozenString(RubySymbol symbol)
FrozenStringback to summary
public FrozenString(String s)

IRBuild.buildGetDefinition returns a frozen string and this is for all intern'd Java strings.

FrozenStringback to summary
protected FrozenString(ByteList byteList)

Method Detail

cloneForInliningback to summary
public Operand cloneForInlining(CloneInfo ii)

Overrides org.jruby.ir.operands.ImmutableLiteral.cloneForInlining.

Annotations
@Override
createCacheObjectback to summary
public RubyString createCacheObject(ThreadContext context)

Implements abstract org.jruby.ir.operands.ImmutableLiteral.createCacheObject.

Doc from org.jruby.ir.operands.ImmutableLiteral.createCacheObject.

Implementing class is responsible for constructing the cached value.

Annotations
@Override
decodeback to summary
public static FrozenString decode(IRReaderDecoder d)
encodeback to summary
public void encode(IRWriterEncoder e)

Overrides org.jruby.ir.operands.Operand.encode.

Annotations
@Override
equalsback 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
getByteListback to summary
public ByteList getByteList()

Implements org.jruby.ir.operands.StringLiteral.getByteList.

getCodeRangeback to summary
public int getCodeRange()

Implements org.jruby.ir.operands.StringLiteral.getCodeRange.

getFileback to summary
public String getFile()
getLineback to summary
public int getLine()
getOperandTypeback to summary
public OperandType getOperandType()

Implements abstract org.jruby.ir.operands.Operand.getOperandType.

Annotations
@Override
getStringback to summary
public String getString()

Implements org.jruby.ir.operands.Stringable.getString.

hashCodeback 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
hasKnownValueback to summary
public boolean hasKnownValue()

Overrides org.jruby.ir.operands.ImmutableLiteral.hasKnownValue.

Doc from org.jruby.ir.operands.Operand.hasKnownValue.

Do we know the value of this operand at compile-time? If we do then it may be possible to constant propagate (one case: We also know it is also an ImmutableLiteral).

Returns:boolean

true if a known compile-time value.

Annotations
@Override
internedStringFromByteListback to summary
private static String internedStringFromByteList(ByteList val)
isCachedback to summary
public boolean isCached()

Overrides org.jruby.ir.operands.ImmutableLiteral.isCached.

Doc from org.jruby.ir.operands.ImmutableLiteral.isCached.

Has this object already been cached?

Annotations
@Override
isTruthyImmediateback to summary
public boolean isTruthyImmediate()

Overrides org.jruby.ir.operands.Operand.isTruthyImmediate.

Doc from org.jruby.ir.operands.Operand.isTruthyImmediate.

Returns true if this is an immediate value that will always be considered truthy (true, numbers, etc)

Annotations
@Override
toStringback 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
visitback to summary
public void visit(IRVisitor visitor)

Overrides org.jruby.ir.operands.Operand.visit.

Annotations
@Override