Magic (Neo4j - CSV reading and parsing 3.2.0-alpha07 API)

java.lang.Object
- org.neo4j.csv.reader.Magic

```
public class Magic
extends Object
```
Logic for detecting and matching magic numbers in file headers.

Field Summary

Fields
Modifier and Type	Field and Description
`static Magic`	`BOM_UTF_16_BE`
`static Magic`	`BOM_UTF_16_LE`
`static Magic`	`BOM_UTF_32_BE` A couple of BOM magics
`static Magic`	`BOM_UTF_32_LE`
`static Magic`	`BOM_UTF_8`
`static Magic`	`GZIP` First 2 bytes of a GZIP file have this signature.
`static Magic`	`NONE`
`static Magic`	`ZIP` First 4 bytes of a ZIP file have this signature.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Magic`	`define(String description, Charset impliesEncoding, int... bytesAsIntsForConvenience)` Defines a magic signature which can later be detected in `of(File)` and `of(byte[])`.
`Charset`	`encoding()`
`boolean`	`impliesEncoding()`
`int`	`length()`
`static int`	`longest()`
`boolean`	`matches(byte[] candidateBytes)` Tests whether or not a set of magic bytes matches this `Magic` signature.
`static Magic`	`of(byte[] bytes)` Matches the magic bytes with all defined and returns a match or `NONE`.
`static Magic`	`of(File file)` Extracts and matches the magic of the header in the given `file`.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NONE
```
public static final Magic NONE
```
  - ZIP
```
public static final Magic ZIP
```
    First 4 bytes of a ZIP file have this signature.
  - GZIP
```
public static final Magic GZIP
```
    First 2 bytes of a GZIP file have this signature.
  - BOM_UTF_32_BE
```
public static final Magic BOM_UTF_32_BE
```
    A couple of BOM magics
  - BOM_UTF_32_LE
```
public static final Magic BOM_UTF_32_LE
```
  - BOM_UTF_16_BE
```
public static final Magic BOM_UTF_16_BE
```
  - BOM_UTF_16_LE
```
public static final Magic BOM_UTF_16_LE
```
  - BOM_UTF_8
```
public static final Magic BOM_UTF_8
```
- Method Detail
  - define
```
public static Magic define(String description,
                           Charset impliesEncoding,
                           int... bytesAsIntsForConvenience)
```
    Defines a magic signature which can later be detected in of(File) and of(byte[]).
    
    Parameters:
    
    description - description of the magic, typically which file it is.
    
    impliesEncoding - if a match for this to-be-defined magic implies that the contents in this file has a certain encoding. Typically used for byte-order-mark.
    
    bytesAsIntsForConvenience - bytes that makes up the magic signature. Here specified as an int[] for convenience of specifying those.
    
    Returns:
    
    the defined Magic instance.
  - of
```
public static Magic of(File file)
                throws IOException
```
    Extracts and matches the magic of the header in the given file. If no magic matches then NONE is returned.
    
    Parameters:
    
    file - File to extract the magic from.
    
    Returns:
    
    matching Magic, or NONE if no match.
    
    Throws:
    
    IOException - for errors reading from the file.
  - of
```
public static Magic of(byte[] bytes)
```
    Matches the magic bytes with all defined and returns a match or NONE.
    
    Parameters:
    
    bytes - magic bytes extracted from a file header.
    
    Returns:
    
    matching Magic, or NONE if no match.
  - longest
```
public static int longest()
```
  - matches
```
public boolean matches(byte[] candidateBytes)
```
    Tests whether or not a set of magic bytes matches this Magic signature.
    
    Parameters:
    
    candidateBytes - magic bytes to test.
    
    Returns:
    
    true if the candidate bytes matches this signature, otherwise false.
  - length
```
public int length()
```
    Returns:
    
    number of bytes making up this magic signature.
  - impliesEncoding
```
public boolean impliesEncoding()
```
    Returns:
    
    whether or not the presence of this Magic implies the contents of the file being of a certain encoding. If true then encoding() may be called to get the implied encoding.
  - encoding
```
public Charset encoding()
```
    Returns:
    
    the encoding this magic signature implies, if impliesEncoding() is true, otherwise throws IllegalStateException.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Magic

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

ZIP

GZIP

BOM_UTF_32_BE

BOM_UTF_32_LE

BOM_UTF_16_BE

BOM_UTF_16_LE

BOM_UTF_8

Method Detail

define

of

of

longest

matches

length

impliesEncoding

encoding

toString