Library API Index

The following is a complete index of the packages, functions, types, methods, and constants include in Joe's aPackage.

• joe package (Joe Standard Library)
  • catch(callable) → CatchResult
  • print(text)
  • printf(fmt, [values...])
  • println([text])
  • AssertError extends Error
    • AssertError(message, [trace, ...]) → AssertError
  • Boolean
    • Boolean.valueOf(string) → Boolean
  • CatchResult
    • CatchResult.error(error) → CatchResult
    • CatchResult.ok(result) → CatchResult
    • catchResult.isError() → Boolean
    • catchResult.isOK() → Boolean
  • Error
    • Error(message, [trace, ...]) → Error
    • error.addInfo(message) → this
    • error.javaStackTrace() → String
    • error.message() → text
    • error.stackTrace() → String
    • error.traces() → List
    • error.type() → name
  • Fact
    • Fact.of(relation, fields)
    • Fact.ofMap(relation, fieldMap)
    • Fact.ofPairs(relation, pairs)
    • Fact(relation, field, ...) → Fact
    • fact.fieldMap() → Map
    • fact.fields() → List
    • fact.isOrdered() → Boolean
    • fact.relation() → String
    • fact.toString() → String
  • Function
  • Joe
    • Joe.compare(a, b) → Number
    • Joe.currentTimeMillis() → Number
    • Joe.getFieldNames(value) → List
    • Joe.isFact(value) → Boolean
    • Joe.isOpaque(value) → Boolean
    • Joe.isType(value) → Boolean
    • Joe.stringify(value) → String
    • Joe.supertypeOf(type) → type
    • Joe.toFact(value) → Fact
    • Joe.typeOf(value) → type
  • Keyword
    • Keyword(name) → Keyword
    • keyword.name() → String
    • keyword.toString() → String
  • List
    • List.of(items...) → List
    • List() → List
    • List(other) → List
    • List(size, [initValue]) → List
    • list.add([index], item) → this
    • list.addAll([index], collection) → this
    • list.clear() → this
    • list.contains(value) → Boolean
    • list.containsAll(collection) → Boolean
    • list.copy() → List
    • list.filter(predicate) → List
    • list.get(index) → value
    • list.getFirst() → value
    • list.getLast() → value
    • list.indexOf(value) → Number
    • list.isEmpty() → Boolean
    • list.lastIndexOf(value) → Number
    • list.map(func) → List
    • list.peekFirst() → value
    • list.peekLast() → value
    • list.remove(value) → Boolean
    • list.removeAll(collection) → Boolean
    • list.removeAt(index) → value
    • list.removeFirst() → value
    • list.removeLast() → value
    • list.reverse() → List
    • list.set(index, newValue) → oldValue
    • list.size() → Number
    • list.sorted([comparator]) → List
    • list.sublist(start, [end]) → List
    • list.toString() → String
  • Map
    • Map.of(values...)
    • Map([other]) → Map
    • map.clear() → this
    • map.containsKey(key) → Boolean
    • map.containsValue(value) → Boolean
    • map.copy() → Map
    • map.get(key) → value
    • map.getOrDefault(key, defaultValue) → value
    • map.isEmpty() → Boolean
    • map.keySet() → Set
    • map.put(key, value) → value
    • map.putAll(map) → this
    • map.remove(key) → value
    • map.size() → Number
    • map.toString() → String
    • map.values() → List
  • Number
    • Number.E
    • Number.MAX_INT
    • Number.MAX_VALUE
    • Number.MIN_INT
    • Number.MIN_VALUE
    • Number.NAN
    • Number.NEGATIVE_INFINITY
    • Number.PI
    • Number.POSITIVE_INFINITY
    • Number.TAU
    • Number.abs(num) → Number
    • Number.acos(num) → Number
    • Number.asin(num) → Number
    • Number.atan(num) → Number
    • Number.atan2(x, y) → Number
    • Number.ceil(num) → Number
    • Number.clamp(num, min, max) → Number
    • Number.cos(a) → Number
    • Number.exp(num) → Number
    • Number.floor(num) → Number
    • Number.hypot(x, y) → Number
    • Number.log(num) → Number
    • Number.log10(num) → Number
    • Number.max(num...) → Number
    • Number.min(num...) → Number
    • Number.mod(a, b) → Number
    • Number.pow(a, b) → Number
    • Number.random() → Number
    • Number.round(num) → Number
    • Number.sin(a) → Number
    • Number.sqrt(num) → Number
    • Number.tan(a) → Number
    • Number.toDegrees(radians) → Number
    • Number.toRadians(degrees) → Number
    • Number(string) → Number
  • Opaque
    • opaque.javaName() → String
    • opaque.name() → String
    • opaque.toString() → String
  • RuleSet
    • ruleSet.infer([inputs]) → Set
    • ruleSet.isDebug() → Boolean
    • ruleSet.isStratified() → Boolean
    • ruleSet.setDebug(flag)
    • ruleSet.toString() → String
  • Set
    • Set(values...) → Set
    • set.add(value) → Boolean
    • set.addAll(collection) → Boolean
    • set.clear() → this
    • set.contains(value) → Boolean
    • set.copy() → Set
    • set.filter(predicate) → Set
    • set.isEmpty() → Boolean
    • set.map(func) → Set
    • set.remove(value) → Boolean
    • set.removeAll(collection) → Boolean
    • set.size() → Number
    • set.sorted([comparator]) → List
    • set.toString() → String
  • String
    • String.format(fmt, [values...]) → String
    • String.join(delimiter, list) → String
    • String(value) → String
    • string.charAt(index) → String
    • string.contains(target) → Boolean
    • string.endsWith(suffix) → Boolean
    • string.equalsIgnoreCase(other) → Boolean
    • string.indent(n) → String
    • string.indexOf(target, [beginIndex], [endIndex]) → Number
    • string.isBlank() → Boolean
    • string.isEmpty() → Boolean
    • string.lastIndexOf(target, [fromIndex]) → Number
    • string.length() → Double
    • string.lines() → List
    • string.matches(pattern) → Boolean
    • string.repeat(count) → String
    • string.replace(target, replacement) → String
    • string.replaceAll(regex, replacement) → String
    • string.replaceFirst(regex, replacement) → String
    • string.split(delimiter) → List
    • string.splitWithDelimiters(delimiter) → List
    • string.startsWith(prefix) → Boolean
    • string.strip() → String
    • string.stripIndent() → String
    • string.stripLeading() → String
    • string.stripTrailing() → String
    • string.substring(beginIndex, [endIndex]) → String
    • string.toLowerCase() → String
    • string.toString() → String
    • string.toUpperCase() → String
  • TextBuilder
    • TextBuilder() → TextBuilder
    • textBuilder.append(value) → this
    • textBuilder.clear() → this
    • textBuilder.print(value) → this
    • textBuilder.printf(fmt, [values...])
    • textBuilder.println(value) → this
    • textBuilder.toString() → String
  • Type
• joe.console package
  • Console
    • Console.args() → List
    • Console.cd(path) → Path
    • Console.exit([code])
    • Console.mkdir(path)
    • Console.pwd() → Path
    • Console.read() → String
    • Console.readFile(filePath) → String
    • Console.readLines(filePath) → List
    • Console.writeFile(filePath, text)
  • Path
    • Path.compare(a, b) → Number
    • Path(first,[more...]) → Path
    • path.endsWith(path) → Boolean
    • path.getFileName() → Path
    • path.getName(index) → Path
    • path.getNameCount() → Number
    • path.getParent() → Path
    • path.isAbsolute() → Boolean
    • path.normalize() → Path
    • path.relativize(other) → Path
    • path.resolve(other) → Path
    • path.startsWith(path) → Boolean
    • path.subpath(start, [end]) → Path
    • path.toAbsolutePath() → Path
    • path.toString() → String
• joe.doc package (JoeDoc Configuration API)
  • DocConfig
    • DocConfig.inputFile(filename,...) → this
    • DocConfig.inputFolder(folder,...) → this
    • DocConfig.outputFolder(folder) → this
• joe.test package (Joe Test Tool API)
  • assertEquals(got, expected)
  • assertError(callable, [message], [frames...])
  • assertFalse(condition)
  • assertTrue(condition)
  • check(value) → ValueChecker
  • checkCatch(callable) → CatchChecker
  • engine() → String
  • fail(message)
  • skip(message)
  • CatchChecker
    • CatchChecker(catchResult) → CatchChecker
    • catchChecker.isError() → Boolean
    • catchChecker.isOK() → this
    • catchChecker.message(expected) → this
    • catchChecker.stackFrames(frame,...) → this
    • catchChecker.stackTrace(expected) → this
    • catchChecker.type(expected) → this
  • JoeTest
    • JoeTest.OPAQUE
  • ValueChecker
    • ValueChecker(value) → ValueChecker
    • valueChecker.containsAll(values...) → this
    • valueChecker.eq(expected) → this
    • valueChecker.hasType(type) → this
    • valueChecker.hasTypeName(name) → this
    • valueChecker.isEmpty() → this
    • valueChecker.isFalse() → this
    • valueChecker.isNotNull() → this
    • valueChecker.isNull() → this
    • valueChecker.isTrue() → this
• joe.win package
  • Button extends Control
    • Button([text], [action]) → Button
    • button.action(callable) → this
    • button.text(text) → this
  • Control extends Region
    • control.tooltip(tooltip) → this
    • control.tooltipText(text) → this
  • GridPane extends Pane
    • GridPane() → GridPane
    • gridPane.at(column, row, [columnSpan, rowSpan], node) → this
    • gridPane.hgap(pixels) → this
    • gridPane.vgap(pixels) → this
  • HBox extends Pane
    • HBox.getHgrow(node) → Priority
    • HBox.getMargin(node) → Insets
    • HBox.setHgrow(node, priority)
    • HBox.setMargin(node, insets)
    • HBox() → HBox
    • hBox.spacing(pixels) → this
  • HPos
    • HPos.CENTER
    • HPos.LEFT
    • HPos.RIGHT
    • HPos.values() → List
    • HPos(value) → HPos
    • hPos.name() → String
    • hPos.ordinal() → Number
    • hPos.toString() → String
  • Insets
    • Insets(pixels) → Insets
    • Insets(top, right, bottom, left) → Insets
    • insets.getBottom() → Number
    • insets.getLeft() → Number
    • insets.getRight() → Number
    • insets.getTop() → Number
  • Label extends Control
    • Label([text]) → Label
    • label.text(text) → this
  • ListView extends Control
    • ListView() → ListView
    • listView.getItems() → joe.List
    • listView.getSelectedIndex() → joe.Number
    • listView.getSelectedItem() → item
    • listView.item(item) → this
    • listView.items(list) → this
    • listView.onSelect(callable) → this
    • listView.placeholder(node) → this
    • listView.placeholderText(text) → this
    • listView.selectIndex(index) → this
    • listView.selectItem(item) → this
    • listView.stringifier(callable) → this
  • Menu
    • Menu() → Menu
    • menu.disable([flag]) → this
    • menu.getProperty(keyword) → value
    • menu.id(id) → this
    • menu.isDisabled() → joe.Boolean
    • menu.item(item) → this
    • menu.items() → joe.List
    • menu.listenTo(keyword, listener) → this
    • menu.properties() → joe.Set
    • menu.setProperty(keyword, value) → this
    • menu.styleClasses() → joe.List
    • menu.styles(style, ...) → this
    • menu.text(text) → this
    • menu.toString() → joe.String
  • MenuBar extends Control
    • MenuBar([text]) → MenuBar
    • menuBar.menu(menu) → this
    • menuBar.menus() → joe.List
  • MenuItem
    • MenuItem() → MenuItem
    • menuItem.action(callable) → this
    • menuItem.disable([flag]) → this
    • menuItem.getProperty(keyword) → value
    • menuItem.id(id) → this
    • menuItem.isDisabled() → joe.Boolean
    • menuItem.listenTo(keyword, listener) → this
    • menuItem.properties() → joe.Set
    • menuItem.setProperty(keyword, value) → this
    • menuItem.styleClasses() → joe.List
    • menuItem.styles(style, ...) → this
    • menuItem.text(text) → this
    • menuItem.toString() → joe.String
  • Node
    • node.disable([flag]) → this
    • node.getProperty(keyword) → value
    • node.gridColumn(index) → this
    • node.gridColumnSpan(span) → this
    • node.gridHalignment(hpos) → this
    • node.gridHgrow([priority]) → this
    • node.gridMargin(insets) → this
    • node.gridRow(index) → this
    • node.gridRowSpan(span) → this
    • node.gridValignment(vpos) → this
    • node.gridVgrow([priority]) → this
    • node.hgrow([priority]) → this
    • node.id(id) → this
    • node.isDisabled() → joe.Boolean
    • node.listenTo(keyword, listener) → this
    • node.properties() → joe.Set
    • node.setProperty(keyword, value) → this
    • node.splitResizeWithParent(flag) → this
    • node.styleClasses() → joe.List
    • node.styles(style, ...) → this
    • node.toString() → joe.String
    • node.vgrow([priority]) → this
  • Orientation
    • Orientation.HORIZONTAL
    • Orientation.VERTICAL
    • Orientation.values() → List
    • Orientation(value) → Orientation
    • orientation.name() → String
    • orientation.ordinal() → Number
    • orientation.toString() → String
  • Pane extends Region
    • Pane() → Pane
    • pane.child(node) → this
    • pane.children() → joe.List
  • Pos
    • Pos.BASELINE_CENTER
    • Pos.BASELINE_LEFT
    • Pos.BASELINE_RIGHT
    • Pos.BOTTOM_CENTER
    • Pos.BOTTOM_LEFT
    • Pos.BOTTOM_RIGHT
    • Pos.CENTER
    • Pos.CENTER_LEFT
    • Pos.CENTER_RIGHT
    • Pos.TOP_CENTER
    • Pos.TOP_LEFT
    • Pos.TOP_RIGHT
    • Pos.values() → List
    • Pos(value) → Pos
    • pos.name() → String
    • pos.ordinal() → Number
    • pos.toString() → String
  • Priority
    • Priority.ALWAYS
    • Priority.NEVER
    • Priority.SOMETIMES
    • Priority.values() → List
    • Priority(value) → Priority
    • priority.name() → String
    • priority.ordinal() → Number
    • priority.toString() → String
  • Region extends Node
    • Region.USE_COMPUTED_SIZE
    • Region.USE_PREF_SIZE
    • region.height(height) → this
    • region.padding(pixels) → this
    • region.padding(top, right, bottom, left) → this
    • region.prefHeight(height) → this
    • region.prefWidth(width) → this
    • region.width(width) → this
  • Separator extends Control
    • Separator() → Separator
    • separator.horizontal() → this
    • separator.vertical() → this
  • Side
    • Side.BOTTOM
    • Side.LEFT
    • Side.RIGHT
    • Side.TOP
    • Side.values() → List
    • Side(value) → Side
    • side.name() → String
    • side.ordinal() → Number
    • side.toString() → String
  • SplitPane extends Control
    • SplitPane() → SplitPane
    • splitPane.getDividers() → joe.List
    • splitPane.horizontal() → this
    • splitPane.item(item) → this
    • splitPane.items() → joe.List
    • splitPane.setDivider(index position) → this
    • splitPane.setDividers(position,...) → this
    • splitPane.vertical() → this
  • StackPane extends Pane
    • StackPane.getAlignment(node) → Pos
    • StackPane.getMargin(node) → Insets
    • StackPane.setAlignment(node, pos)
    • StackPane.setMargin(node, insets)
    • StackPane() → StackPane
  • Tab
    • Tab() → Tab
    • tab.content(node) → this
    • tab.disable([flag]) → this
    • tab.getProperty(keyword) → value
    • tab.id(id) → this
    • tab.isDisabled() → joe.Boolean
    • tab.isSelected() → joe.Boolean
    • tab.listenTo(keyword, listener) → this
    • tab.properties() → joe.Set
    • tab.setProperty(keyword, value) → this
    • tab.styleClasses() → joe.List
    • tab.styles(style, ...) → this
    • tab.tabPane() → TabPane
    • tab.text(text) → this
    • tab.toString() → joe.String
  • TabPane extends Control
    • TabPane([text]) → TabPane
    • tabPane.tab(tab) → this
    • tabPane.tabs() → joe.List
  • VBox extends Pane
    • VBox.getMargin(node) → Insets
    • VBox.getVgrow(node) → Priority
    • VBox.setMargin(node, insets)
    • VBox.setVgrow(node, priority)
    • VBox() → VBox
    • vBox.spacing(pixels) → this
  • VPos
    • VPos.BASELINE
    • VPos.BOTTOM
    • VPos.CENTER
    • VPos.TOP
    • VPos.values() → List
    • VPos(value) → VPos
    • vPos.name() → String
    • vPos.ordinal() → Number
    • vPos.toString() → String
  • Win
    • Win.css(css) → this
    • Win.cssFile(filename) → this
    • Win.root() → VBox
    • Win.setSize(width, height) → this
    • Win.setTitle(title) → this