CommandLineParameters Data Type

This is a JCommander-annotated class that holds parameters for OTP stand-alone mode. These parameters can be parsed from the command line, or provided in a file using Jcommander's at-symbol syntax (see http://jcommander.org/#Syntax). When stand-alone OTP is started as a daemon, parameters are loaded from such a file, located by default in '/etc/opentripplanner.cfg'. Note that JCommander-annotated parameters can be any type that can be constructed from a string. This module also contains classes for validating parameters. See: http://jcommander.org/#Parameter_validation Some parameter fields are not initialized so when inferring other parameters, we can check for null and see whether they were specified on the command line.

Implemented Interfaces
Cloneable
Properties
name data type constraints description
help boolean required
version boolean required
serializationVersionId boolean required
build boolean required
buildStreet boolean required
load boolean required
loadStreet boolean required
save boolean required
cacheDirectory File  
serve boolean required
bindAddress string  
clientDirectory File  
disableFileCache boolean required
maxThreads number  
port number  
securePort number  
visualize boolean required
baseDirectory array of File   The remaining single parameter after the switches is the directory with the configuration files. This directory may contain other files like the graph, input data and report files.

Example

{
  "help" : true,
  "version" : true,
  "serializationVersionId" : true,
  "build" : true,
  "buildStreet" : true,
  "load" : true,
  "loadStreet" : true,
  "save" : true,
  "cacheDirectory" : {
    "parent" : "...",
    "canonicalFile" : { },
    "absolute" : true,
    "file" : true,
    "totalSpace" : 12345,
    "usableSpace" : 12345,
    "freeSpace" : 12345,
    "absolutePath" : "...",
    "absoluteFile" : { },
    "name" : "...",
    "parentFile" : { },
    "path" : "...",
    "directory" : true,
    "hidden" : true,
    "canonicalPath" : "..."
  },
  "serve" : true,
  "bindAddress" : "...",
  "clientDirectory" : {
    "parent" : "...",
    "canonicalFile" : { },
    "absolute" : true,
    "file" : true,
    "totalSpace" : 12345,
    "usableSpace" : 12345,
    "freeSpace" : 12345,
    "absolutePath" : "...",
    "absoluteFile" : { },
    "name" : "...",
    "parentFile" : { },
    "path" : "...",
    "directory" : true,
    "hidden" : true,
    "canonicalPath" : "..."
  },
  "disableFileCache" : true,
  "maxThreads" : 12345,
  "port" : 12345,
  "securePort" : 12345,
  "visualize" : true,
  "baseDirectory" : [ {
    "parent" : "...",
    "canonicalFile" : { },
    "absolute" : true,
    "file" : true,
    "totalSpace" : 12345,
    "usableSpace" : 12345,
    "freeSpace" : 12345,
    "absolutePath" : "...",
    "absoluteFile" : { },
    "name" : "...",
    "parentFile" : { },
    "path" : "...",
    "directory" : true,
    "hidden" : true,
    "canonicalPath" : "..."
  }, {
    "parent" : "...",
    "canonicalFile" : { },
    "absolute" : true,
    "file" : true,
    "totalSpace" : 12345,
    "usableSpace" : 12345,
    "freeSpace" : 12345,
    "absolutePath" : "...",
    "absoluteFile" : { },
    "name" : "...",
    "parentFile" : { },
    "path" : "...",
    "directory" : true,
    "hidden" : true,
    "canonicalPath" : "..."
  } ]
}