[DOCS] FileBot Groovy Expression References

[rednoah]

FileBot uses the Groovy language for format expressions, filter expressions and execute expressions:
http://groovy-lang.org/single-page-documentation.html


The most important top-level bindings are documented here:
https://www.filebot.net/naming.html


In addition to that, the entire FileBot / Groovy / Java API is at your disposal:

• FileBot API Documentation
• Groovy API Documentation
• Java API Documentation

The complete reference documentation for FileBot / Java / Groovy is so mind-bogglingly vast that it's likely going to be completely useless for your specific relatively simple coding needs.

You will need Java / Groovy coding experience to navigate this vast amount of reference documentation.


e.g. Why does this work?

Code: Select all

{f.name.match(/regex/)}

1. {f} is a top-level binding defined by FileBot, which returns a File object.
2. File.getName() is called via the Groovy Getter Syntax and returns a String object.
3. String.match(String regex) is a Groovy Extension Method for the String class specific to FileBot.

You can read / write / modify to your liking / generally make sense of typical FileBot format / filter / exec expressions without understanding how any of it works under the hood.

[devster]

Pardon my nosiness, how do you generate these pages?
They're a real eye opener, for example I had no idea String.match() could accept a map.

[rednoah]

The FileBot API Documentation is generated from the source using the javadoc tool.