org.elasticsearch.index.store

Class StoreFileMetaData

java.lang.Object

org.elasticsearch.index.store.StoreFileMetaData

All Implemented Interfaces:

Streamable

public class StoreFileMetaData
extends Object
implements Streamable

Constructor Summary

Constructors

Constructor and Description
StoreFileMetaData(String name, long length)
StoreFileMetaData(String name, long length, String checksum)
StoreFileMetaData(String name, long length, String checksum, org.apache.lucene.util.Version writtenBy)
StoreFileMetaData(String name, long length, String checksum, org.apache.lucene.util.Version writtenBy, org.apache.lucene.util.BytesRef hash)

Method Summary

Modifier and Type	Method and Description
String	checksum() Returns a string representation of the files checksum.
org.apache.lucene.util.BytesRef	hash() Returns a variable length hash of the file represented by this metadata object.
boolean	hasLegacyChecksum() Returns true iff the checksum is not null and if the file has NOT been written by a Lucene version greater or equal to Lucene 4.8
boolean	isSame(StoreFileMetaData other) Returns true iff the length and the checksums are the same.
long	length() the actual file size on "disk", if compressed, the compressed size
String	name() Returns the name of this file
void	readFrom(StreamInput in)
static StoreFileMetaData	readStoreFileMetaData(StreamInput in)
String	toString()
void	writeTo(StreamOutput out)
org.apache.lucene.util.Version	writtenBy() Returns the Lucene version this file has been written by or null if unknown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StoreFileMetaData

public StoreFileMetaData(String name,
                         long length)

StoreFileMetaData

public StoreFileMetaData(String name,
                         long length,
                         String checksum)

StoreFileMetaData

public StoreFileMetaData(String name,
                         long length,
                         String checksum,
                         org.apache.lucene.util.Version writtenBy)

StoreFileMetaData

public StoreFileMetaData(String name,
                         long length,
                         String checksum,
                         org.apache.lucene.util.Version writtenBy,
                         org.apache.lucene.util.BytesRef hash)

Method Detail

name

public String name()

Returns the name of this file

length

public long length()

the actual file size on "disk", if compressed, the compressed size

checksum

@Nullable
public String checksum()

Returns a string representation of the files checksum. Since Lucene 4.8 this is a CRC32 checksum written by lucene. Previously we use Adler32 on top of Lucene as the checksum algorithm, if hasLegacyChecksum() returns true this is a Adler32 checksum.

isSame

public boolean isSame(StoreFileMetaData other)

Returns true iff the length and the checksums are the same. otherwise false

readStoreFileMetaData

public static StoreFileMetaData readStoreFileMetaData(StreamInput in)
                                               throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

writtenBy

public org.apache.lucene.util.Version writtenBy()

Returns the Lucene version this file has been written by or null if unknown

hasLegacyChecksum

public boolean hasLegacyChecksum()

Returns true iff the checksum is not null and if the file has NOT been written by a Lucene version greater or equal to Lucene 4.8

hash

public org.apache.lucene.util.BytesRef hash()

Returns a variable length hash of the file represented by this metadata object. This can be the file itself if the file is small enough. If the length of the hash is 0 no hash value is available