Macro Index | bnd
Description: Bnd/Bndtools. Tooling to build OSGi bundles including Eclipse, Maven, and Gradle plugins.

- # Macro Index

  page | Description | Class
  apply ';' MACRO (';' LIST)* | Convert a list to an invoction with arguments | Macro
  average (';' LIST )* | The average of a list, if no members exception is thrown | Macro
  base64 ';' FILE [';' LONG ] | Get the Base64 encoding of a file | Macro
  basedir | Get the basedirectory of this processor | Processor
  basename ( ';' FILEPATH ) + | A list of the basename (the final part) of a set of file paths. | Macro
  basenameext ';' PATH ( ';' EXTENSION ) | The basename of the given path optionally minus a specified extension | Macro
  bndversion | Returns the current running bnd version as full major.minor.micro | Macro
  bsn | Provide the current bsn when a JAR is generated. This can differ from the Project's bsn when there are sub-bundles. | Analyzer
  bytes ( ';' LONG )* | Format bytes | Macro
  cat ';' FILEPATH | The contents of a file | Macro
  classes ( ; QUERY ( ; PATTERN )? )* | A list of class names filtered by a query language | Analyzer
  compare STRING STRING | Compare two strings by using the compareTo method of the String class. | Macro
  currenttime | The current epoch time in long integer format | Macro
  decorated ';' NAME [ ';' BOOLEAN ] | The merged and decorated Parameters object | Macro
  def ';' KEY (';' STRING)? | The value of the specified property name or a default if macro is not defined. The default is an empty string if not specified. | Macro
  digest ';' ALGORITHM ';' FILE | Get a digest of a file | Macro
  dir ( ';' FILE )* | Returns a list of the directories containing each specified file | Macro
  driver ( ';' NAME )? | the driver of the environment (e.g. gradle, eclipse, intellij) | Workspace
  ee | The name of the highest execution environment found in the current JAR | Analyzer
  endswith ';' STRING ';' SUFFIX | Check if the given string ends with the given prefix | Macro
  env ';' KEY (';' STRING)? | The given environment variable or a default if the environment variable is not defined. The default is an empty string if not specified. | Macro
  error ( ';' STRING )* | Raise an error consisting of all concatenated strings | Macro
  exporters ';' PACKAGE | The list of jars that export the given package | Analyzer
  exports | A list if exported packages | Analyzer
  extension ';' PATH | The file extension of the given path or empty string if no extension | Macro
  fileuri ';' PATH | Return a file uri for the specified path. Relative paths are resolved against the domain processor base. | Macro
  filter ';' LIST ';' REGEX | Filters entries in a list that matching a regular expression | Macro
  filterout ';' LIST ';' REGEX | Filters out entries in a list that matching a regular expression | Macro
  find ';' VALUE ';' SEARCHED | The starting position ofof SEARCHED (not a regex) in VALUE | Macro
  findfile ';' PATH ( ';' FILTER ) | A filtered list of relative paths from a directory and its subdirectories | Project
  findlast ';' VALUE ';' SEARCHED | The starting position of SEARCHED (not a regex) in VALUE when searching from the end | Macro
  findname ';' PATH ( ';' FILTER ) | A list of filtered by name resource paths with optional replacement | Project
  findpath ';' REGEX ( ';' REPLACE )? | A list of filtered by path resource paths with optional replacement | Project
  findproviders ';' namespace ( ';' FILTER ( ';' STRATEGY)? )? | find resources in the workspace repository matching the given namespace and optional filter. Intended for use in bndrun files. STRATEGY can one of ALL, REPOS or WORKSPACE. | Workspace
  first (';' LIST )* | First element of a list | Macro
  fmodified ( ';' RESOURCE )+ | Latest modification date of a list of resources | Macro
  foreach ';' MACRO (';' LIST)* | Iterator over a list, calling a macro with the value and index | Macro
  format ';' STRING (';' ANY )* | Print a formatted string using Locale.ROOT, automatically converting variables to the specified format if possible. | Macro
  frange ';' VERSION ( ';' BOOLEAN )? | a range expression for a filter from a version. By default this is based on consumer compatibility. You can specify a third argument (true) to get provider compatibility. | Analyzer
  gestalt ';' NAME ( ';' NAME (';' ANY )? )? | provides access to the gestalt properties that describe the environment. | Workspace
  get ';' INDEX (';' LIST )* | The element from the concatenated lists at the given index | Macro
  githead | Get the head commit number. Look for a .git/HEAD file, going up in the file hierarchy. Then get this file, and resolve any symbolic reference. | Builder
  glob ';' GLOBEXP | Return the regular expression for the specified glob expression | Macro
  global ';' KEY ( ';' DEFAULT )? | A current user setting from the ~/.bnd/settings.json file | Workspace
  ide ';' ( 'javac.target' | 'javac.source' ) | This reads the source and target settings from the IDE | Project
  if ';' STRING ';' STRING ( ';' STRING )? | Conditional macro that depending on a condition returns either a value for true or optionally for false. | Macro
  imports | A list of the currently imported package names | Analyzer
  indexof ';' STRING (';' LIST )* | The index of the given string in the list, or -1 if not found | Macro
  is ( ';' ANY )* | Check if the given values are all equal | Macro
  isdir ( ';' FILE )+ | True if all given files are directories, false if no file arguments | Macro
  isempty ( ';' STRING )* | True if all given strings are empty | Macro
  isfile (';' FILE )+ | Returns true if all given files actually exist and are not a directory or special file. | Macro
  isnumber ( ';' STRING )* | Check if the given strings are numbers | Macro
  join ( ';' LIST )+ | Join a number of list/values into a single list | Macro
  js (';' JAVASCRIPT )* | Execute Javascript, return the value of the last expression | Macro
  last (';' LIST )* | Last element of a list | Macro
  lastindexof ';' STRING (';' LIST )* | The last index of the given string in the list, or -1 if not found | Macro
  length STRING | The length of the given string | Macro
  list (';' KEY)* | Returns a list of the values of the named properties with escaped semicolons. | Macro
  literal ';' STRING | A literal value for the macro, i.e. it surrounds the value with the macro prefix and suffix. | Macro
  long2date | Turn a long time into a date | Macro
  lsa ';' DIR (';' SELECTORS ) | A list of absolute paths for files in the given directory optionally filtered by selectors. | Macro
  lsr ';' DIR (';' SELECTORS ) | A list of file names in the given directory optionally filtered by selectors. | Macro
  map ';' MACRO (';' LIST)* | Map a list to a new list using a function | Macro
  matches STRING REGEX | Check if the given string matches the regular expression | Macro
  maven_version ';' MAVEN-VERSION | Cleanup a potential maven version to make it match an OSGi Version syntax. | Builder
  max (';' LIST )* | Maximum string in the lists | Macro
  md5 ';' RESOURCE | The MD5 digest of an existing resource in the JAR | Analyzer
  min (';' LIST )* | Minimum string in the lists | Macro
  native_capability ( ';' ( 'os.name' | 'os.version' | 'os.processor' ) '=' STRING )* | Create a Require-Capability header based on the current platform or explicit values | Processor
  ncompare NUMBER NUMBER | Compare two numbers by using the Double.compare method. | Macro
  nmax (';' LIST )* | Maximum number in the lists | Macro
  nmin (';' LIST )* | Minimum number in the lists | Macro
  now ( 'long' | DATEFORMAT ) | Current date and time, default is default Date format. The format can be specified as a long or a date format. | Macro
  nsort (';' LIST )+ | Concatenate a set of lists and sort their contents nummerically | Macro
  osfile ';' DIR ';' NAME | Create a path to a file in OS dependent form. | Macro
  p_allsourcepath | Path to all sources | Project
  p_bootclasspath | The project's boot class path | Project
  p_buildpath | The project's buildpath | Project
  p_dependson | Provides a list of project names this project depends on | Project
  p_output | The absolute path to the project's output/target directory | Project
  p_sourcepath | The path to the project's source directory. | Project
  p_testpath | The path of JARs placed on the remote VM's classpath for testing | Project
  packageattribute ';' PACKAGE (';' ATTRIBUTE)? | The value of a package attribute | Analyzer
  packages | A list of package names filtered by a query language | Analyzer
  path ( ';' FILES )+ | A list of file paths separated by the platform's path separator. | Macro
  pathseparator | The platform's path separator | Macro
  permissions (';' ( 'packages' | 'admin' | 'permissions' ) )+ | A file in the format for the OSGi permissions resource. | Builder
  propertiesdir | The directory of the properties file | Processor
  propertiesname | Return the name of the properties file | Project
  rand (';' MIN ' (;' MAX )?)? | A random number between 0 and 100, or between the given range (inclusive). | Macro
  random | Generate a random string, which is guaranteed to be a valid Java identifier | Processor
  range ';' RANGE_MASK ( ';' VERSION ) | Create a semantic version range out of a version using a mask to control the bump of the ceiling | Macro
  reject ';' LIST ';' REGEX | Rejects a list by matching it against a regular expression | Macro
  removeall ';' LIST ';' LIST | Return the first list where items from the second list are removed | Macro
  replace ';' LIST ';' REGEX (';' STRING (';' STRING)? )? | Replace elements in a list when it matches a regular expression | Macro
  replacelist ';' LIST ';' REGEX (';' STRING (';' STRING)? )? | Replace elements in a list when it matches a regular expression | Macro
  replacestring ';' STRING ';' REGEX (';' STRING )? | Replace elements in a string when it matches a regular expression | Macro
  repo ';' BSN ( ';' VERSION ( ';' STRATEGY )? )? | Provides the file paths to artifact in the repositories | Project
  repodigests ( ';' NAME )* | Get the repository digests (describing their contents) for all or the specified names | Workspace
  repos | A list of the current repositories | Project
  retainall ';' LIST ';' LIST | Return the first list where items not in the second list are removed | Macro
  reverse (';' LIST )* | A reversed list | Macro
  select ';' LIST ';' REGEX | Selects entries in a list that matching a regular expression | Macro
  separator | The platform file separator | Macro
  sha1 ';' RESOURCE | The SHA-1 digest of an existing resource in the JAR | Analyzer
  size ( ';' LIST )* | Count the number of elements (of all collections combined) | Macro
  sjoin ';' SEPARATOR ( ';' LIST )+ | Join a number of list/values into a single list with a given separator | Macro
  sort (';' LIST )+ | Concatenate a set of lists and sort their contents on their string value | Macro
  split ';' REGEX (';' STRING )* | Split a number of strings into a list using a regular expression | Macro
  startswith ';' STRING ';' PREFIX | Check if the given string starts with the given prefix | Macro
  stem ';' STRING | Return the string up to but not including the first dot | Macro
  sublist ';' START ';' END (';' LIST )* | Return a sublist of the list | Macro
  subst ';' STRING ';' REGEX (';' STRING (';' NUMBER )? )? | Substitute all the regex matches in the target for the given value; if a count is specified, limit the number of replacements to that count. | Macro
  substring ';' STRING ';' START ( ';' END )? | Return a substring of a given string, negative indexes allowed | Macro
  sum (';' LIST )* | The sum of a list | Macro
  system ';' STRING ( ';' STRING )? | Execute a system command | Macro
  system_allow_fail ';' STRING ( ';' STRING )? | Execute a system command but ignore any failures | Macro
  template ';' NAME [ ';' template ]+ | Expand the entries of a merged and decorated Parameters object using a template that can refer to the key and attributes | Macro
  thisfile | Return the name of the properties file for this Processor | Processor
  toclasspath ';' LIST ( ';' BOOLEAN )? | Convert a list of class names to a list of paths. | Macro
  toclassname ';' FILES | Translate a list of relative file paths to class names. The files can either end with .class or .java | Macro
  tolower STRING | Turn a string into an lower case string | Macro
  toupper STRING | Turn a string into an uppercase string | Macro
  trim ';' STRING | Remove whitespace around the given string | Macro
  tstamp ( ';' DATEFORMAT ( ';' TIMEZONE ( ';' LONG )? )? )? | Create a timestamp based on a date format. Default format is "yyyyMMddHHmm" | Macro
  unescape ( ';' STRING )* | The concatenated input will have all \n, \r, \b, \f, and \t replaced with their control code. | Macro
  uniq (';' LIST )* | Concatenate the lists and then remove any duplicates. | Macro
  uri ';' URI (';' URI)? | Resolve a uri against a base uri. | Processor
  user ';' KEY ( ';' DEFAULT )? | A current user setting from the ~/.bnd/settings.json file | Workspace
  vcompare VERSION VERSION | Compare two version strings | Macro
  version MASK VERSION? | Modify a version using a template. This is an alias to the versionmask macro. | Macro
  version_cleanup ';' VERSION | Cleanup a potential maven version to make it match the OSGi Version syntax. | Macro
  versionmask MASK VERSION? | Modify a version using a template | Macro
  vmax (';' LIST )* | Maximum version in the lists | Macro
  vmin (';' LIST )* | Minimum version in the lists | Macro
  warning ( ';' STRING )* | Raise an error consisting of all concatenated strings | Macro
  workspace | The absolute file path to the current workspace | Workspace