Top Inners Fields Constructors Methods
org.jruby.ext.zlib

public Class RubyGzipFile

extends RubyObject
implements IOEncodable
Class Inheritance
All Implemented Interfaces
org.jruby.util.io.IOEncodable
Known Direct Subclasses
org.jruby.ext.zlib.JZlibRubyGzipReader, org.jruby.ext.zlib.JZlibRubyGzipWriter
Annotations
@JRubyClass
name:Zlib::GzipFile
Imports
org.jcodings.Encoding, org.jcodings.transcode.EConv, org.joda.time.DateTime, org.jruby.Ruby, .RubyBasicObject, .RubyClass, .RubyModule, .RubyObject, .RubyString, .RubyTime, org.jruby.anno.JRubyClass, .JRubyMethod, org.jruby.api.Access, org.jruby.runtime.Block, .Helpers, .JavaSites, .ThreadContext, org.jruby.runtime.builtin.IRubyObject, org.jruby.util.ByteList, org.jruby.util.io.EncodingUtils, .IOEncodable

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static class
public static class
public static class

Field Summary

Modifier and TypeField and Description
protected boolean
protected EConv
protected int
protected IRubyObject
protected Encoding
protected Encoding
protected boolean
protected boolean
protected int
protected RubyTime
protected RubyString
protected RubyString
protected final byte
protected EConv
protected IRubyObject
protected boolean
protected EConv
Inherited from org.jruby.RubyObject:
IVAR_INSPECTING_OBJECT_ALLOCATOROBJECT_ALLOCATORREIFYING_OBJECT_ALLOCATOR

Constructor Summary

AccessConstructor and Description
public
RubyGzipFile(Ruby runtime, RubyClass type)

Method Summary

Modifier and TypeMethod and Description
public IRubyObject
close()
Deprecated since 10.0.

public IRubyObject
public IRubyObject
closed_p()
Deprecated

public IRubyObject
public IRubyObject
comment()
Deprecated since 10.0.

public IRubyObject
public IRubyObject
crc()
Deprecated

public IRubyObject
crc(ThreadContext context)

protected void
public IRubyObject
finish()
Deprecated since 10.0.

public IRubyObject
public boolean
public int
public IRubyObject
public Encoding
public Encoding
public Encoding
public Encoding
getReadEncoding()
Deprecated since 10.0.

public Encoding
protected boolean
public IRubyObject
level()
Deprecated

public IRubyObject
public IRubyObject
public static RubyGzipFile
newInstance(IRubyObject recv, Block block)
Deprecated since 10.0.

public static RubyGzipFile
protected RubyString
newStr(Ruby runtime, ByteList value)
Deprecated since 10.0.

protected RubyString
newStr(ThreadContext context, ByteList value)

public IRubyObject
orig_name()
Deprecated since 10.0.

public IRubyObject
public IRubyObject
os_code()
Deprecated

public IRubyObject
public IRubyObject
public IRubyObject
public IRubyObject
respond_to(ThreadContext context, IRubyObject name, IRubyObject includePrivate)

public IRubyObject
set_sync(IRubyObject arg)
Deprecated since 10.0.

public IRubyObject
public void
public void
public void
public void
public void
private static JavaSites.ZlibSites
sites(ThreadContext context)

Hides org.jruby.RubyObject.sites.

Retrieve the call sites for this class.

public IRubyObject
sync()
Deprecated

public IRubyObject
public IRubyObject
to_io()
Deprecated since 10.0.

public IRubyObject
public static IRubyObject
wrap(ThreadContext context, IRubyObject recv, IRubyObject io, Block block)
Deprecated since 10.0.

public static IRubyObject
wrap(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)

public static IRubyObject
wrap19(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
Deprecated since 10.0.

pack-priv static IRubyObject
wrapBlock(ThreadContext context, RubyGzipFile instance, Block block)

Inherited from org.jruby.RubyObject:
attachToObjectSpacecallInitcallInitcallInitcallInitcallInitcallInitcallInitcallInitcallInitcallInitconvertToTypedigdig1dig2eqlInternalequalInternalequalsfinishObjectClassgetNativeClassIndexhashCodeinspectop_eqqputsspecificEvaltoRubyStringtoString

Field Detail

closedback to summary
protected boolean closed
ecback to summary
protected EConv ec
ecflagsback to summary
protected int ecflags
ecoptsback to summary
protected IRubyObject ecopts
encback to summary
protected Encoding enc
enc2back to summary
protected Encoding enc2
finishedback to summary
protected boolean finished
hasBOMback to summary
protected boolean hasBOM
levelback to summary
protected int level
mtimeback to summary
protected RubyTime mtime
nullFreeCommentback to summary
protected RubyString nullFreeComment
nullFreeOrigNameback to summary
protected RubyString nullFreeOrigName
osCodeback to summary
protected final byte osCode
readTranscoderback to summary
protected EConv readTranscoder
realIoback to summary
protected IRubyObject realIo
syncback to summary
protected boolean sync
writeTranscoderback to summary
protected EConv writeTranscoder

Constructor Detail

RubyGzipFileback to summary
public RubyGzipFile(Ruby runtime, RubyClass type)

Method Detail

closeback to summary
public IRubyObject close()

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
closeback to summary
public IRubyObject close(ThreadContext context)
Annotations
@JRubyMethod
name:close
closed_pback to summary
public IRubyObject closed_p()

Deprecated

Annotations
@Deprecated
closed_pback to summary
public IRubyObject closed_p(ThreadContext context)
Annotations
@JRubyMethod
name:closed?
commentback to summary
public IRubyObject comment()

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
commentback to summary
public IRubyObject comment(ThreadContext context)
Annotations
@JRubyMethod
name:comment
crcback to summary
public IRubyObject crc()

Deprecated

Annotations
@Deprecated
crcback to summary
public IRubyObject crc(ThreadContext context)
Annotations
@JRubyMethod
name:crc
ecoptsback to summary
protected void ecopts(ThreadContext context, IRubyObject opts)
finishback to summary
public IRubyObject finish()

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
finishback to summary
public IRubyObject finish(ThreadContext context)
Annotations
@JRubyMethod
name:finish
getBOMback to summary
public boolean getBOM()

Implements org.jruby.util.io.IOEncodable.getBOM.

Annotations
@Override
getEcflagsback to summary
public int getEcflags()

Implements org.jruby.util.io.IOEncodable.getEcflags.

Annotations
@Override
getEcoptsback to summary
public IRubyObject getEcopts()

Implements org.jruby.util.io.IOEncodable.getEcopts.

Annotations
@Override
getEncback to summary
public Encoding getEnc()

Implements org.jruby.util.io.IOEncodable.getEnc.

getEnc2back to summary
public Encoding getEnc2()

Implements org.jruby.util.io.IOEncodable.getEnc2.

getInternalEncodingback to summary
public Encoding getInternalEncoding()
getReadEncodingback to summary
public Encoding getReadEncoding()

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
getReadEncodingback to summary
public Encoding getReadEncoding(ThreadContext context)
isClosedback to summary
protected boolean isClosed()
levelback to summary
public IRubyObject level()

Deprecated

Annotations
@Deprecated
levelback to summary
public IRubyObject level(ThreadContext context)
Annotations
@JRubyMethod
name:level
mtimeback to summary
public IRubyObject mtime()
Annotations
@JRubyMethod
name:mtime
newInstanceback to summary
public static RubyGzipFile newInstance(IRubyObject recv, Block block)

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
newInstanceback to summary
public static RubyGzipFile newInstance(ThreadContext context, IRubyObject recv, Block block)
Annotations
@JRubyMethod
name:new
meta:true
newStrback to summary
protected RubyString newStr(Ruby runtime, ByteList value)

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
newStrback to summary
protected RubyString newStr(ThreadContext context, ByteList value)
orig_nameback to summary
public IRubyObject orig_name()

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
orig_nameback to summary
public IRubyObject orig_name(ThreadContext context)
Annotations
@JRubyMethod
name:orig_name
os_codeback to summary
public IRubyObject os_code()

Deprecated

Annotations
@Deprecated
os_codeback to summary
public IRubyObject os_code(ThreadContext context)
Annotations
@JRubyMethod
name:os_code
pathback to summary
public IRubyObject path(ThreadContext context)
Annotations
@JRubyMethod
respond_toback to summary
public IRubyObject respond_to(ThreadContext context, IRubyObject name)
Annotations
@JRubyMethod
name:respond_to?
frame:true
respond_toback to summary
public IRubyObject respond_to(ThreadContext context, IRubyObject name, IRubyObject includePrivate)
Annotations
@JRubyMethod
name:respond_to?
frame:true
set_syncback to summary
public IRubyObject set_sync(IRubyObject arg)

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
set_syncback to summary
public IRubyObject set_sync(ThreadContext context, IRubyObject arg)
Annotations
@JRubyMethod
name:sync=
setBOMback to summary
public void setBOM(boolean bom)

Implements org.jruby.util.io.IOEncodable.setBOM.

Annotations
@Override
setEcflagsback to summary
public void setEcflags(int ecflags)

Implements org.jruby.util.io.IOEncodable.setEcflags.

Annotations
@Override
setEcoptsback to summary
public void setEcopts(IRubyObject ecopts)

Implements org.jruby.util.io.IOEncodable.setEcopts.

Annotations
@Override
setEncback to summary
public void setEnc(Encoding readEncoding)

Implements org.jruby.util.io.IOEncodable.setEnc.

Annotations
@Override
setEnc2back to summary
public void setEnc2(Encoding writeEncoding)

Implements org.jruby.util.io.IOEncodable.setEnc2.

Annotations
@Override
sitesback to summary
private static JavaSites.ZlibSites sites(ThreadContext context)

Hides org.jruby.RubyObject.sites.

Doc from org.jruby.RubyBasicObject.sites.

Retrieve the call sites for this class. It is expected that all Java-based core classes that do call site caching will have a similar method.

syncback to summary
public IRubyObject sync()

Deprecated

Annotations
@Deprecated
syncback to summary
public IRubyObject sync(ThreadContext context)
Annotations
@JRubyMethod
name:sync
to_ioback to summary
public IRubyObject to_io()

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
to_ioback to summary
public IRubyObject to_io(ThreadContext context)
Annotations
@JRubyMethod
name:to_io
wrapback to summary
public static IRubyObject wrap(ThreadContext context, IRubyObject recv, IRubyObject io, Block block)

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
wrapback to summary
public static IRubyObject wrap(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
Annotations
@JRubyMethod
meta:true
name:wrap
required:1
optional:1
checkArity:false
wrap19back to summary
public static IRubyObject wrap19(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)

Deprecated

since 10.0.

Annotations
@Deprecated
since:10.0
wrapBlockback to summary
pack-priv static IRubyObject wrapBlock(ThreadContext context, RubyGzipFile instance, Block block)
org.jruby.ext.zlib back to summary

public Class RubyGzipFile.CRCError

extends Error
Class Inheritance
Annotations
@JRubyClass
name:Zlib::GzipFile::CRCError
parent:Zlib::GzipFile::Error

Constructor Summary

AccessConstructor and Description
public

Constructor Detail

CRCErrorback to summary
public CRCError()
org.jruby.ext.zlib back to summary

public Class RubyGzipFile.Error

extends Object
Class Inheritance
Known Direct Subclasses
org.jruby.ext.zlib.RubyGzipFile.CRCError, org.jruby.ext.zlib.RubyGzipFile.NoFooter, org.jruby.ext.zlib.RubyGzipFile.LengthError
Annotations
@JRubyClass
name:Zlib::GzipFile::Error
parent:Zlib::Error

Constructor Summary

AccessConstructor and Description
public

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Errorback to summary
public Error()
org.jruby.ext.zlib back to summary

public Class RubyGzipFile.LengthError

extends Error
Class Inheritance
Annotations
@JRubyClass
name:Zlib::GzipFile::LengthError
parent:Zlib::GzipFile::Error

Constructor Summary

AccessConstructor and Description
public

Constructor Detail

LengthErrorback to summary
public LengthError()
org.jruby.ext.zlib back to summary

public Class RubyGzipFile.NoFooter

extends Error
Class Inheritance
Annotations
@JRubyClass
name:Zlib::GzipFile::NoFooter
parent:Zlib::GzipFile::Error

Constructor Summary

AccessConstructor and Description
public

Constructor Detail

NoFooterback to summary
public NoFooter()