FSA (fsa 6.311.10 API)

java.lang.Object
- com.yahoo.fsa.FSA

```
public class FSA
extends Object
```
Finite-State Automaton.

Author:

Peter Boros

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FSA.Iterator` Class used to iterate over all accepted strings in the fsa.
`static class`	`FSA.State` Thread local state object used to traverse a Finite-State Automaton.

Constructor Summary

Constructors
Constructor and Description
`FSA(FileInputStream filename)` Loads an FSA from a file input stream using utf-8 encoding
`FSA(FileInputStream filename, String charsetname)` Loads an FSA from a file input stream using the specified character encoding
`FSA(String filename)` Loads an FSA from a file using utf-8 encoding
`FSA(String filename, String charsetname)` Loads an FSA from a file using the specified character encoding.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected ByteBuffer`	`data(int state)` Retrieves data for the given state using the underlying fsa data buffer.
`protected String`	`dataString(int state)` Retrieves data for the given state using the underlying fsa data buffer.
`protected int`	`delta(int state, byte symbol)`
`FSA.State`	`getState()`
`protected int`	`hashDelta(int state, byte symbol)`
`boolean`	`hasPerfectHash()`
`protected boolean`	`isFinal(int state)`
`boolean`	`isOk()`
`FSA.Iterator`	`iterator()` Returns a new iterator to the start state.
`FSA.Iterator`	`iterator(FSA.State state)` Returns a new iterator to the given state.
`static FSA`	`loadFromResource(String resourceFileName, Class loadingClass)` Loads an FSA from a resource file name, which is resolved from the class path of the class loader of the given class.
`String`	`lookup(String str)` Convenience method that returns the metadata string in the fsa for the input lookup String, or null if the input string does not exist in the fsa.
`static void`	`main(String[] args)`
`int`	`serial()`
`protected int`	`start()`
`int`	`version()`

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

- Constructor Detail
  - FSA
```
public FSA(String filename)
```
    Loads an FSA from a file using utf-8 encoding
    
    Throws:
    
    IllegalArgumentException - if the file is not found
  - FSA
```
public FSA(String filename,
           String charsetname)
```
    Loads an FSA from a file using the specified character encoding.
    
    Throws:
    
    IllegalArgumentException - if the file is not found
  - FSA
```
public FSA(FileInputStream filename)
```
    Loads an FSA from a file input stream using utf-8 encoding
  - FSA
```
public FSA(FileInputStream filename,
           String charsetname)
```
    Loads an FSA from a file input stream using the specified character encoding
- Method Detail
  - getState
```
public FSA.State getState()
```
  - iterator
```
public FSA.Iterator iterator()
```
    Returns a new iterator to the start state.
  - iterator
```
public FSA.Iterator iterator(FSA.State state)
```
    Returns a new iterator to the given state.
    
    Parameters:
    
    state - the state to create the iterator from.
  - loadFromResource
```
public static FSA loadFromResource(String resourceFileName,
                                   Class loadingClass)
```
    Loads an FSA from a resource file name, which is resolved from the class path of the class loader of the given class.
    This is useful for loading fsa's deployed within OSGi bundles.
    
    Parameters:
    
    resourceFileName - the name of the file, relative to any element on the classpath. For example, if the classpath contains resources/ and the file is resources/myfsa.fsa this argument should be myfsa.fsa
    
    loadingClass - a class which provides the class loader to use for loading. Any class which is loaded from the same class path as the resource will do (e.g with OSGi - any class in the same bundle jar)
    
    Returns:
    
    the loaded FSA
    
    Throws:
    
    RuntimeException - if the class could not be loaded
  - isOk
```
public boolean isOk()
```
  - hasPerfectHash
```
public boolean hasPerfectHash()
```
  - version
```
public int version()
```
  - serial
```
public int serial()
```
  - start
```
protected int start()
```
  - delta
```
protected int delta(int state,
                    byte symbol)
```
  - hashDelta
```
protected int hashDelta(int state,
                        byte symbol)
```
  - isFinal
```
protected boolean isFinal(int state)
```
  - data
```
protected ByteBuffer data(int state)
```
    Retrieves data for the given state using the underlying fsa data buffer.
    
    Parameters:
    
    state - The fsa state to retrieve data from.
    
    Returns:
    
    A new buffer containing the data for the given state.
  - dataString
```
protected String dataString(int state)
```
    Retrieves data for the given state using the underlying fsa data buffer.
    
    Parameters:
    
    state - The fsa state to retrieve data from.
    
    Returns:
    
    A string representation of the data for the given state.
  - lookup
```
public String lookup(String str)
```
    Convenience method that returns the metadata string in the fsa for the input lookup String, or null if the input string does not exist in the fsa.
    
    Parameters:
    
    str - The string to look up.
    
    Returns:
    
    Metadata string from the fsa.
  - main
```
public static void main(String[] args)
```

Class FSA

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FSA

FSA

FSA

FSA

Method Detail

getState

iterator

iterator

loadFromResource

isOk

hasPerfectHash

version

serial

start

delta

hashDelta

isFinal

data

dataString

lookup

main