org.apache.lucene.util

Class CodecUtil

java.lang.Object

org.apache.lucene.util.CodecUtil

public final class CodecUtil
extends java.lang.Object

Utility class for reading and writing versioned headers. This is useful to ensure that a file is in the format you think it is.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Method Summary

Methods

Modifier and Type	Method and Description
static int	checkHeader(DataInput in, java.lang.String codec, int minVersion, int maxVersion)
static int	headerLength(java.lang.String codec)
static DataOutput	writeHeader(DataOutput out, java.lang.String codec, int version)

Methods inherited from class java.lang.Object

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

Method Detail

writeHeader

public static DataOutput writeHeader(DataOutput out,
                     java.lang.String codec,
                     int version)
                              throws java.io.IOException

Throws:

java.io.IOException

headerLength

public static int headerLength(java.lang.String codec)

checkHeader

public static int checkHeader(DataInput in,
              java.lang.String codec,
              int minVersion,
              int maxVersion)
                       throws java.io.IOException

Throws:

java.io.IOException