tech.sourced.enry

Class Enry

java.lang.Object

tech.sourced.enry.Enry

public class Enry
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static Guess	unknownLanguage

Constructor Summary

Constructors

Constructor and Description
Enry()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getLanguage(java.lang.String filename, byte[] content) Returns the language of the given file based on the filename and its contents.
static Guess	getLanguageByContent(java.lang.String filename, byte[] content) Returns detected language by its content.
static Guess	getLanguageByEmacsModeline(byte[] content) Returns detected language by its emacs modeline.
static Guess	getLanguageByExtension(java.lang.String filename) Returns detected language by the extension of the filename.
static Guess	getLanguageByFilename(java.lang.String filename) Returns detected language by its filename.
static Guess	getLanguageByModeline(byte[] content) Returns detected language by its modeline.
static Guess	getLanguageByShebang(byte[] content) Returns detected language by its shebang.
static Guess	getLanguageByVimModeline(byte[] content) Returns detected language by its vim modeline.
static java.lang.String[]	getLanguageExtensions(java.lang.String language) Returns all the possible extensions for a file in the given language.
static java.lang.String[]	getLanguages(java.lang.String filename, byte[] content) Returns all possible languages for the given file.
static java.lang.String	getMimeType(java.lang.String path, java.lang.String language) Returns the mime type of the file.
static boolean	isAuxiliaryLanguage(java.lang.String language) Returns whether the given language is auxiliary or not.
static boolean	isBinary(byte[] content) Reports whether the given file content is binary or not.
static boolean	isConfiguration(java.lang.String path) Reports whether the given file or directory is a config file or directory.
static boolean	isDocumentation(java.lang.String path) Reports whether the given file or directory it's documentation.
static boolean	isDotFile(java.lang.String path) Reports whether the given file is a dotfile.
static boolean	isImage(java.lang.String path) Reports whether the given path is an image or not.
static boolean	isVendor(java.lang.String path) Reports whether the given path is a vendor path or not.

Methods inherited from class java.lang.Object

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

Field Detail

unknownLanguage

public static final Guess unknownLanguage

Constructor Detail

Enry

public Enry()

Method Detail

isAuxiliaryLanguage

public static boolean isAuxiliaryLanguage(java.lang.String language)

Returns whether the given language is auxiliary or not.

Parameters:

language - name of the language, e.g. PHP, HTML, ...

Returns:

if it's an auxiliary language

getLanguage

public static java.lang.String getLanguage(java.lang.String filename,
                                           byte[] content)

Returns the language of the given file based on the filename and its contents.

Parameters:

filename - name of the file with the extension

content - array of bytes with the contents of the file (the code)

Returns:

the guessed language

getLanguageByContent

public static Guess getLanguageByContent(java.lang.String filename,
                                         byte[] content)

Returns detected language by its content. If there are more than one possible language, it returns the first language in alphabetical order and safe to false.

Parameters:

filename - name of the file with the extension

content - of the file

Returns:

guessed result

getLanguageByEmacsModeline

public static Guess getLanguageByEmacsModeline(byte[] content)

Returns detected language by its emacs modeline. If there are more than one possible language, it returns the first language in alphabetical order and safe to false.

Parameters:

content - of the file

Returns:

guessed result

getLanguageByExtension

public static Guess getLanguageByExtension(java.lang.String filename)

Returns detected language by the extension of the filename. If there are more than one possible languages, it returns the first language in alphabetical order and safe to false.

Parameters:

filename - of the file

Returns:

guessed result

getLanguageByShebang

public static Guess getLanguageByShebang(byte[] content)

Returns detected language by its shebang. If there are more than one possible language, it returns the first language in alphabetical order and safe to false.

Parameters:

content - of the file

Returns:

guessed result

getLanguageByFilename

public static Guess getLanguageByFilename(java.lang.String filename)

Returns detected language by its filename. If there are more than one possible language, it returns the first language in alphabetical order and safe to false.

Parameters:

filename - of the file

Returns:

guessed result

getLanguageByModeline

public static Guess getLanguageByModeline(byte[] content)

Returns detected language by its modeline. If there are more than one possible language, it returns the first language in alphabetical order and safe to false.

Parameters:

content - of the file

Returns:

guessed result

getLanguageByVimModeline

public static Guess getLanguageByVimModeline(byte[] content)

Returns detected language by its vim modeline. If there are more than one possible language, it returns the first language in alphabetical order and safe to false.

Parameters:

content - of the file

Returns:

guessed result

getLanguageExtensions

public static java.lang.String[] getLanguageExtensions(java.lang.String language)

Returns all the possible extensions for a file in the given language.

Parameters:

language - to get extensions from

Returns:

extensions

getLanguages

public static java.lang.String[] getLanguages(java.lang.String filename,
                                              byte[] content)

Returns all possible languages for the given file.

Parameters:

filename - of the file

content - of the file

Returns:

all possible languages

getMimeType

public static java.lang.String getMimeType(java.lang.String path,
                                           java.lang.String language)

Returns the mime type of the file.

Parameters:

path - of the file

language - of the file

Returns:

mime type

isBinary

public static boolean isBinary(byte[] content)

Reports whether the given file content is binary or not.

Parameters:

content - of the file

Returns:

whether it's binary or not

isConfiguration

public static boolean isConfiguration(java.lang.String path)

Reports whether the given file or directory is a config file or directory.

Parameters:

path - of the file or directory

Returns:

whether it's config or not

isDocumentation

public static boolean isDocumentation(java.lang.String path)

Reports whether the given file or directory it's documentation.

Parameters:

path - of the file or directory. It must not contain its parents and if it's a directory it must end in a slash e.g. "docs/" or "foo.json".

Returns:

whether it's docs or not

isDotFile

public static boolean isDotFile(java.lang.String path)

Reports whether the given file is a dotfile.

Parameters:

path - of the file

Returns:

whether it's a dotfile or not

isImage

public static boolean isImage(java.lang.String path)

Reports whether the given path is an image or not.

Parameters:

path - of the file

Returns:

whether it's an image or not

isVendor

public static boolean isVendor(java.lang.String path)

Reports whether the given path is a vendor path or not.

Parameters:

path - of the file or directory

Returns:

whether it's vendor or not