Class ExpressionFormatMethods

java.lang.Object

net.filebot.format.ExpressionFormatMethods

public class ExpressionFormatMethods
extends Object

Method Summary

Modifier and Type	Method	Description
static String	acronym(String self)	Convert to acronym.
static String	after(String self, String pattern)	Match substring before the given pattern or return the original value.
static File	ascii(File self)
static String	ascii(String self)	Convert Unicode characters to ASCII.
static String	ascii(String self, String fallback)
static String	asciiQuotes(String self)
static String	before(String self, String pattern)	Match substring before the given pattern or return the original value.
static StructuredFile	bitwiseNegate(StructuredFile self)	Nullify the Movies / TV Series folder level.
static List<?>	bounds(Iterable<?> self)
static Object	check(Object self, Closure<?> c)	Unwind if an object does not satisfy the given predicate.
static String	clean(String self)	Strip brackets and other clutter patterns.
static String	colon(String self, String colon)	Replace all colons.
static String	colon(String self, String colon, String ratio)
static int	compareTo(Temporal self, String date)
static StructuredFile	derive(StructuredFile self, Object tag, Object... tags)	Add values to the file name, after the file name, but before the subtitle language suffix and file extension.
static StructuredFile	deriveFolder(StructuredFile self, Object tag, Object... tags)	Add a value to the movie / series folder name.
static File	div(File self, File path)
static File	div(File self, String path)
static File	div(File self, List<Object> path)
static File	div(String self, File path)
static File	div(String self, String path)
static Matcher	findMatch(String self, String pattern)	Find match in case-insensitive mode.
static Matcher	findWordMatch(String self, String pattern)	Find match in between word boundaries in case-insensitive mode.
static String	format(TemporalAmount self, String pattern)
static String	format(TemporalAmount self, String pattern, Locale locale)
static String	format(Temporal self, String pattern)
static String	format(Temporal self, String pattern, Locale locale)
static String	format(Date self, String format)
static String	format(Date self, String format, Locale locale)
static long	getDiskSpace(File self)
static List<String>	getGraphemeClusters(String self)
static File	getRelativePathTail(File self, int tailSize)
static File	getRoot(File self)
static File	getTail(File self)
static String	initialName(String self)	Reduce first name to initials.
static boolean	isLatin(String self)
static String	joining(Collection<?> self, String delimiter)
static String	joining(Collection<?> self, String delimiter, String prefix, String suffix)
static String	joiningDistinct(Collection<?> self, String delimiter, Closure<?>... mapper)
static String	joiningDistinct(Collection<?> self, String delimiter, String prefix, String suffix, Closure<?>... mapper)
static StructuredFile	leftShift(StructuredFile self, Object tag)	Add a value to the season folder level.
static List<File>	listPath(File self)
static List<File>	listPath(File self, int tailSize)
static String	lower(String self)	Convert all characters to lower case/ e.g.
static String	lower(String self, String pattern)
static String	lowerTrail(String self)	Convert all trailing characters to lower case.
static String	match(String self, String pattern)	Match pattern and return or unwind if pattern cannot be found.
static String	match(String self, String pattern, int matchGroup)
static Object	match(String self, Map<?,?> matcher)	Find matching pattern and return mapped value.
static Object	match(Collection<?> self, Map<?,?> matcher)
static List<String>	matchAll(String self, String pattern)	Match all occurrences of the given pattern or unwind if pattern cannot be found.
static List<String>	matchAll(String self, String pattern, int matchGroup)
static List<String>	matchBrackets(String self)	Match brackets pattern.
static File	mod(File self, Object suffix)
static StructuredFile	mod(StructuredFile self, Object tag)	Add values to the file name, after the file name, but before the subtitle language suffix and file extension.
static StructuredFile	multiply(StructuredFile self, Object tag)	Add a value to the movie / series folder name.
static ReverseComparable	negative(Comparable self)
static String	pad(CharSequence self, int length, CharSequence padding)
static String	pad(Number self, int length)
static String	pad(String self, int... length)	Pad number patterns to length using the given character.
static Date	parseDate(String self)
static Date	parseDate(String self, String format)
static Date	parseDate(String self, String format, Locale locale)
static File	plus(File self, String path)
static String	plus(String self, Closure closure)
static StructuredFile	power(StructuredFile self, Object tag)	Add a value to the file name and the movie / series folder name.
static String	remove(String self, String character, String... characters)
static String	removeAll(String self, String pattern)
static String	removeBrackets(String self)	Remove brackets pattern.
static String	removeIllegalCharacters(String self)	Strip characters that aren't allowed on Windows from the given filename.
static String	replace(String self, Map<?,?> replacer)	Apply replacement mappings.
static Collection<String>	replace(Collection<?> self, Map<String,String> replacer)	Apply replacement mappings.
static String	replaceAll(String self, String pattern)
static String	replaceIllegalCharacters(String self)	Replace characters that aren't allowed on Windows from the given filename with similar-looking unicode equivalents
static String	replacePart(String self)	Strip trailing part number.
static String	replacePart(String self, String replacement)	Replace trailing part number.
static String	replaceTrailingBrackets(String self)	Strip trailing parenthesis.
static String	replaceTrailingBrackets(String self, String replacement)	Replace trailing parenthesis.
static StructuredFile	rightShift(StructuredFile self, Object tag)	Add a value to the A-Z folder level.
static String	roman(Integer n, TreeMap<Integer,String> numerals)
static String	roman(String self)	Replace numbers 1..12 with Roman numerals.
static Number	round(Number self, int precision)	Round decimal number to precision.
static String	slash(String self, String replacement)	Replace all slashes.
static String	sortInitial(String self)
static String	sortName(String self)	Convert to sort name.
static String	sortName(String self, String replacement)	Convert to sort name with custom replacement pattern e.g.
static String	space(String self, String replacement)	Replace all spaces.
static LocalDateTime	toDate(Long self)
static LocalDateTime	toDate(Long self, String zone)
static File	toFile(String self)
static File	toFile(String self, String parent)
static Locale	toLocale(String self)
static String	transliterate(String self, String transformIdentifier)	Apply any ICU script transliteration.
static String	truncate(String self, int limit)
static String	truncate(String self, int hardLimit, String nonWordPattern)
static String	upper(String self)	Convert all characters to upper case.
static String	upper(String self, String pattern)
static String	upperInitial(String self)	Convert all initial characters to upper case.
static StructuredFile	xor(StructuredFile self, Object tag)	Replace subtitle language suffix.
static ZonedDateTime	zone(Temporal self, String zone)

Methods inherited from class java.lang.Object

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

Method Details

lower

public static String lower(String self)

Convert all characters to lower case/ e.g. "Firelfy" ➔ "firefly"

lower

public static String lower(String self,
 String pattern)

upper

public static String upper(String self)

Convert all characters to upper case. e.g. "Firelfy" ➔ "FIREFLY"

upper

public static String upper(String self,
 String pattern)

pad

public static String pad(String self,
 int... length)

Pad number patterns to length using the given character. e.g. "1x01" ➔ "01x001"

pad

public static String pad(Number self,
 int length)

pad

public static String pad(CharSequence self,
 int length,
 CharSequence padding)

round

public static Number round(Number self,
 int precision)

Round decimal number to precision. e.g. "3.14" ➔ "3.1"

match

public static String match(String self,
 String pattern)

Match pattern and return or unwind if pattern cannot be found.

match

public static String match(String self,
 String pattern,
 int matchGroup)

matchAll

public static List<String> matchAll(String self,
 String pattern)

Match all occurrences of the given pattern or unwind if pattern cannot be found.

matchAll

public static List<String> matchAll(String self,
 String pattern,
 int matchGroup)

replaceAll

public static String replaceAll(String self,
 String pattern)

removeAll

public static String removeAll(String self,
 String pattern)

remove

public static String remove(String self,
 String character,
 String... characters)

removeIllegalCharacters

public static String removeIllegalCharacters(String self)

Strip characters that aren't allowed on Windows from the given filename. e.g. "Sissi: The Young Empress" ➔ "Sissi The Young Empress"

replaceIllegalCharacters

public static String replaceIllegalCharacters(String self)

Replace characters that aren't allowed on Windows from the given filename with similar-looking unicode equivalents

clean

public static String clean(String self)

Strip brackets and other clutter patterns. e.g. [ONe]_Ano_Hana_01_(1280x720) ➔ Ano Hana 01

space

public static String space(String self,
 String replacement)

Replace all spaces. e.g. "Doctor Who" ➔ "Doctor_Who"

colon

public static String colon(String self,
 String colon)

Replace all colons. e.g. "Sissi: The Young Empress" ➔ "Sissi - The Young Empress"

colon

public static String colon(String self,
 String colon,
 String ratio)

slash

public static String slash(String self,
 String replacement)

Replace all slashes. e.g. "V_MPEG4/ISO/AVC" ➔ "V_MPEG4.ISO.AVC"

upperInitial

public static String upperInitial(String self)

Convert all initial characters to upper case. e.g. "The Day a new Demon was born" ➔ "The Day A New Demon Was Born"

lowerTrail

public static String lowerTrail(String self)

Convert all trailing characters to lower case. e.g. "Gundam SEED" ➔ "Gundam Seed"

sortName

public static String sortName(String self)

Convert to sort name. e.g. "The Walking Dead" ➔ "Walking Dead"

sortName

public static String sortName(String self,
 String replacement)

Convert to sort name with custom replacement pattern e.g. "The Gabby Hayes Show (1956)" ➔ "Gabby Hayes Show, The (1956)"

sortInitial

public static String sortInitial(String self)

initialName

public static String initialName(String self)

Reduce first name to initials. e.g. "James Cameron" ➔ "J. Cameron"

truncate

public static String truncate(String self,
 int limit)

truncate

public static String truncate(String self,
 int hardLimit,
 String nonWordPattern)

before

public static String before(String self,
 String pattern)

Match substring before the given pattern or return the original value.

after

public static String after(String self,
 String pattern)

Match substring before the given pattern or return the original value.

findMatch

public static Matcher findMatch(String self,
 String pattern)

Find match in case-insensitive mode.

findWordMatch

public static Matcher findWordMatch(String self,
 String pattern)

Find match in between word boundaries in case-insensitive mode.

matchBrackets

public static List<String> matchBrackets(String self)

Match brackets pattern. e.g. "The IT Crowd (UK)" ➔ "UK"

removeBrackets

public static String removeBrackets(String self)

Remove brackets pattern. e.g. "The IT Crowd (UK)" ➔ "The IT Crowd"

replaceTrailingBrackets

public static String replaceTrailingBrackets(String self)

Strip trailing parenthesis. e.g. "The IT Crowd (UK)" ➔ "The IT Crowd"

replaceTrailingBrackets

public static String replaceTrailingBrackets(String self,
 String replacement)

Replace trailing parenthesis. e.g. "The IT Crowd (UK)" ➔ "The IT Crowd [UK]"

replacePart

public static String replacePart(String self)

Strip trailing part number. e.g. "Today Is the Day (1)" ➔ "Today Is the Day"

replacePart

public static String replacePart(String self,
 String replacement)

Replace trailing part number. e.g. "Today Is the Day (1)" ➔ "Today Is the Day, Part 1"

acronym

public static String acronym(String self)

Convert to acronym. e.g. "Deep Space 9" ➔ "DS9"

roman

public static String roman(String self)

Replace numbers 1..12 with Roman numerals. e.g. "Star Wars: Episode 4" ➔ "Star Wars: Episode IV"

roman

public static String roman(Integer n,
 TreeMap<Integer,String> numerals)

transliterate

public static String transliterate(String self,
 String transformIdentifier)

Apply any ICU script transliteration. e.g. "中国" ➔ "zhōng guó"

ascii

public static String ascii(String self)

Convert Unicode characters to ASCII. e.g. "カタカナ" ➔ "katakana"

ascii

public static String ascii(String self,
 String fallback)

asciiQuotes

public static String asciiQuotes(String self)

isLatin

public static boolean isLatin(String self)

getGraphemeClusters

public static List<String> getGraphemeClusters(String self)

replace

public static String replace(String self,
 Map<?,?> replacer)

Apply replacement mappings. e.g. replace(ä:'ae', ö:'oe', ü:'ue')

replace

public static Collection<String> replace(Collection<?> self,
 Map<String,String> replacer)

Apply replacement mappings. e.g. replace('Directors Cut':'DC')

match

public static Object match(String self,
 Map<?,?> matcher)

Find matching pattern and return mapped value. e.g. az.match('[a-f]': '/volume1', '[g-x]': '/volume2') ?: '/volume3'

match

public static Object match(Collection<?> self,
 Map<?,?> matcher)

joining

public static String joining(Collection<?> self,
 String delimiter)

joining

public static String joining(Collection<?> self,
 String delimiter,
 String prefix,
 String suffix)

joiningDistinct

public static String joiningDistinct(Collection<?> self,
 String delimiter,
 Closure<?>... mapper)

joiningDistinct

public static String joiningDistinct(Collection<?> self,
 String delimiter,
 String prefix,
 String suffix,
 Closure<?>... mapper)

bounds

public static List<?> bounds(Iterable<?> self)

check

public static Object check(Object self,
 Closure<?> c)

Unwind if an object does not satisfy the given predicate. e.g. (0..9)*.check{it invalid input: '<' 10}.sum()

derive

public static StructuredFile derive(StructuredFile self,
 Object tag,
 Object... tags)

Add values to the file name, after the file name, but before the subtitle language suffix and file extension. e.g. "Avatar (2009).mp4" ➔ "Avatar (2009) [720p].mp4"

deriveFolder

public static StructuredFile deriveFolder(StructuredFile self,
 Object tag,
 Object... tags)

Add a value to the movie / series folder name. e.g. Avatar (2009)/Avatar (2009) ➔ Avatar (2009) [TMDB-19995]/Avatar (2009)

mod

public static StructuredFile mod(StructuredFile self,
 Object tag)

Add values to the file name, after the file name, but before the subtitle language suffix and file extension. e.g. plex % {" by $director"} % {" [$vf, $vc, $ac]"}

multiply

public static StructuredFile multiply(StructuredFile self,
 Object tag)

Add a value to the movie / series folder name. e.g. plex * " [TMDB-$id]"

power

public static StructuredFile power(StructuredFile self,
 Object tag)

Add a value to the file name and the movie / series folder name. e.g. plex ** " [TMDB-$id]"

bitwiseNegate

public static StructuredFile bitwiseNegate(StructuredFile self)

Nullify the Movies / TV Series folder level. e.g. ~plex

leftShift

public static StructuredFile leftShift(StructuredFile self,
 Object tag)

Add a value to the season folder level. e.g. plex invalid input: '<'invalid input: '<' { sy.bounds().joining('-', ' [', ']') }

rightShift

public static StructuredFile rightShift(StructuredFile self,
 Object tag)

Add a value to the A-Z folder level. e.g. plex >> { az }

xor

public static StructuredFile xor(StructuredFile self,
 Object tag)

Replace subtitle language suffix. e.g. plex ^ {'.'+lang.ISO2}

ascii

public static File ascii(File self)

getDiskSpace

public static long getDiskSpace(File self)

getRoot

public static File getRoot(File self)

getTail

public static File getTail(File self)

listPath

public static List<File> listPath(File self)

listPath

public static List<File> listPath(File self,
 int tailSize)

getRelativePathTail

public static File getRelativePathTail(File self,
 int tailSize)

toDate

public static LocalDateTime toDate(Long self)

toDate

public static LocalDateTime toDate(Long self,
 String zone)

toFile

public static File toFile(String self)

toFile

public static File toFile(String self,
 String parent)

toLocale

public static Locale toLocale(String self)

format

public static String format(Temporal self,
 String pattern)

format

public static String format(Temporal self,
 String pattern,
 Locale locale)

format

public static String format(TemporalAmount self,
 String pattern)

format

public static String format(TemporalAmount self,
 String pattern,
 Locale locale)

format

public static String format(Date self,
 String format)

format

public static String format(Date self,
 String format,
 Locale locale)

zone

public static ZonedDateTime zone(Temporal self,
 String zone)

parseDate

public static Date parseDate(String self,
 String format)

parseDate

public static Date parseDate(String self,
 String format,
 Locale locale)

parseDate

public static Date parseDate(String self)

compareTo

public static int compareTo(Temporal self,
 String date)

plus

public static File plus(File self,
 String path)

div

public static File div(File self,
 String path)

div

public static File div(String self,
 String path)

div

public static File div(File self,
 File path)

div

public static File div(String self,
 File path)

div

public static File div(File self,
 List<Object> path)

mod

public static File mod(File self,
 Object suffix)

plus

public static String plus(String self,
 Closure closure)

negative

public static ReverseComparable negative(Comparable self)