fix #687 - clean up indenting

Author: sammefford

src/main/java/com/marklogic/client/DatabaseClient.java

@@ -45,178 +45,178 @@
  * with shared access to a database.
  */
 public interface DatabaseClient {
-    /**
-     * Starts a transaction.  You can pass the transaction to the read(), write(), or delete() methods
-     * of a document manager or the search() method of a query manager to perform operations within a
-     * multistatement transaction.
-     * 
-     * To call openTransaction(), an application must authenticate as rest-writer or rest-admin.
-     * 
-     * @return	a Transaction object identifying and supporting operations on the transaction
-     */
-	Transaction openTransaction() throws ForbiddenUserException, FailedRequestException;
-	/**
-	 * Starts a transaction with the specified name, which makes the transaction easier to recognize
-	 * when you get status reports.
-	 * 
-	 * @param name	the transaction name
-     * @return	a Transaction object identifying and supporting operations on the transaction
-	 */
-	Transaction openTransaction(String name) throws ForbiddenUserException, FailedRequestException;
-	/**
-	 * Starts a transaction with the specified name and time limit. If the transaction is not committed
-	 * or rolled back within the specified time, the transaction rolls back automatically.
-	 * 
-	 * @param name	the transaction name
-	 * @param timeLimit	the number of the transaction in seconds
-     * @return	a Transaction object identifying and supporting operations on the transaction
-	 */
-	Transaction openTransaction(String name, int timeLimit) throws ForbiddenUserException, FailedRequestException;
-
-    /**
-     * Creates a document manager for documents with unknown or heterogeneous formats.
-     * @return	a manager supporting generic operations on documents
-     */
-    GenericDocumentManager newDocumentManager();
-    /**
-     * Creates a document manager for documents with a binary format such as images.
-     * @return	a manager supporting operations on binary documents
-     */
-    BinaryDocumentManager newBinaryDocumentManager();
-    /**
-     * Creates a document manager for documents containing a JSON structure.
-     * @return	a manager supporting operations on JSON documents
-     */
-    JSONDocumentManager newJSONDocumentManager();
-    /**
-     * Creates a document manager for documents containing unstructured text.
-     * @return	a manager supporting operations on text documents
-     */
-    TextDocumentManager newTextDocumentManager();
-    /**
-     * Creates a document manager for documents containing XML.
-     * @return	a manager supporting operations on XMLdocuments
-     */
-    XMLDocumentManager newXMLDocumentManager();
-
-    /**
-     * Creates a manager for long-running asynchronous write or query jobs.  Don't forget
-     * to call dataMovementManager.release() when you're done with it.
-     * @return	a manager supporting long-running asynchronous write or query jobs
-     */
-    DataMovementManager newDataMovementManager();
-
-    /**
-     * Creates a manager to query for database documents.
-     * @return	a manager supporting search operations and lookup of values and tuples in indexes (also known as lexicons)
-     */
-    QueryManager newQueryManager();
-
-    /**
-     * Creates a manager to retrieve rows from the database.
-     * @return	a manager supporting plans for processing database rows
-     */
-    RowManager newRowManager();
-
-    /**
-     * Creates a manager for building rules and rules-matching applications.
-     * @return a manager for supporting rules and rule-match operations.
-     */
-    RuleManager newRuleManager();
-    
-    /**
-     * Creates a manager for configuring the REST server for the database. The
-     * ServerConfigurationManager can persist query options and transforms or
-     * set properties of the server. The application must have rest-admin
-     * privileges to use the ServerConfigurationManager.
-     * 
-     * @return	a manager for the server properties or administrative resources
-     */
-    ServerConfigurationManager newServerConfigManager();
-
-    /** Creates a manager for CRUD operations on semantic graphs.
-     * @return the new GraphManager instance
-     */
-    GraphManager newGraphManager();
-    
-    /** Creates a manager for executing SPARQL queries and retrieving results.
-     * @return the new SPARQLQueryManager instance
-     */
-    SPARQLQueryManager newSPARQLQueryManager();
-    
-    /**
-     * Creates a PojoRepository specific to the specified class and its id type. 
-     * The PojoRepository provides a facade for persisting, retrieving, and
-     * querying data contained in Java objects.  Annotations are required to
-     * identify the id field and any fields for which you wish to create indexes.
-     *
-     * @param clazz the class type for this PojoRepository to handle
-     * @param idClass the class type of the id field for this clazz, must obviously 
-     *          be Serializable or we'll struggle to marshall it
-     * @param <T> the pojo type this PojoRepository will manage
-     * @param <ID> the scalar type of the id for pojos of type &lt;T&gt;
-     * @return the initialized PojoRepository
-     **/
-    <T, ID extends Serializable> PojoRepository<T, ID> newPojoRepository(Class<T> clazz, Class<ID> idClass);
-
-    /**
-     * Initializes a manager for a extension resource.
-     * 
-     * @param resourceName	the name of the extension resource
-     * @param resourceManager	the manager for the extension resource
-     * @param <T> the type of ResourceManager to init for the extension resource
-     * @return	the initialized resource manager
-     */
-    <T extends ResourceManager> T init(String resourceName, T resourceManager);
-
-    /**
-     * Creates a logger for document and query requests.  To merge the logging output
-     * with the output from other loggers, pass the output stream used by the other
-     * loggers.
-     * 
-     * @param out	the output stream for the logging output
-     * @return	the logger for client requests
-     */
-    RequestLogger newLogger(OutputStream out);
-
-    /**
-     * Closes the database client and releases associated resources.  After the client is closed,
-     * document and query managers can no longer access the database.
-     */
-    void release();
-
-    /**
-     * Returns the client object from the library that implements communication with the
-     * server.  You should call this method only when you need short-term workarounds such
-     * as configuring communication with the server.  The client implementation object and
-     * library may change without notice or be removed without replacement in a future release.
-     * 
-     * In addition, your changes to the configuration of the client implementation object
-     * could impair the operation of the MarkLogic Java Client API.  In short, the client
-     * implementation object should be used only on an interim basis by experts who test
-     * thoroughly to avoid unwanted side effects.
-     * 
-     * You can call the getClass().getName() and getClass().getPackage().getName() to discover
-     * the class of the current implementation object.
-     * @return	the object implementing communication with the server 
-     */
-    Object getClientImplementation();
-
-    /**
-     * Creates a ServerEvaluationCall for eval and invoke of server-side xquery or 
-     * javascript code.  Eval requires the xdbc:eval privilege and invoke requires the
-     * xdbc:invoke privilege.  If this DatabaseClient is pointed at a database different
-     * than the default for this REST server, you will need the xdbc:eval-in or xdbc:invoke-in
-     * privilege.
-     * @return the new ServerEvaluationCall instance
-     */
-    ServerEvaluationCall newServerEval();
-
-    String getHost();
-
-    int getPort();
-
-    String getDatabase();
-
-    SecurityContext getSecurityContext();
+  /**
+   * Starts a transaction.  You can pass the transaction to the read(), write(), or delete() methods
+   * of a document manager or the search() method of a query manager to perform operations within a
+   * multistatement transaction.
+   *
+   * To call openTransaction(), an application must authenticate as rest-writer or rest-admin.
+   *
+   * @return	a Transaction object identifying and supporting operations on the transaction
+   */
+  Transaction openTransaction() throws ForbiddenUserException, FailedRequestException;
+  /**
+   * Starts a transaction with the specified name, which makes the transaction easier to recognize
+   * when you get status reports.
+   *
+   * @param name	the transaction name
+   * @return	a Transaction object identifying and supporting operations on the transaction
+   */
+  Transaction openTransaction(String name) throws ForbiddenUserException, FailedRequestException;
+  /**
+   * Starts a transaction with the specified name and time limit. If the transaction is not committed
+   * or rolled back within the specified time, the transaction rolls back automatically.
+   *
+   * @param name	the transaction name
+   * @param timeLimit	the number of the transaction in seconds
+   * @return	a Transaction object identifying and supporting operations on the transaction
+   */
+  Transaction openTransaction(String name, int timeLimit) throws ForbiddenUserException, FailedRequestException;
+
+  /**
+   * Creates a document manager for documents with unknown or heterogeneous formats.
+   * @return	a manager supporting generic operations on documents
+   */
+  GenericDocumentManager newDocumentManager();
+  /**
+   * Creates a document manager for documents with a binary format such as images.
+   * @return	a manager supporting operations on binary documents
+   */
+  BinaryDocumentManager newBinaryDocumentManager();
+  /**
+   * Creates a document manager for documents containing a JSON structure.
+   * @return	a manager supporting operations on JSON documents
+   */
+  JSONDocumentManager newJSONDocumentManager();
+  /**
+   * Creates a document manager for documents containing unstructured text.
+   * @return	a manager supporting operations on text documents
+   */
+  TextDocumentManager newTextDocumentManager();
+  /**
+   * Creates a document manager for documents containing XML.
+   * @return	a manager supporting operations on XMLdocuments
+   */
+  XMLDocumentManager newXMLDocumentManager();
+
+  /**
+   * Creates a manager for long-running asynchronous write or query jobs.  Don't forget
+   * to call dataMovementManager.release() when you're done with it.
+   * @return	a manager supporting long-running asynchronous write or query jobs
+   */
+  DataMovementManager newDataMovementManager();
+
+  /**
+   * Creates a manager to query for database documents.
+   * @return	a manager supporting search operations and lookup of values and tuples in indexes (also known as lexicons)
+   */
+  QueryManager newQueryManager();
+
+  /**
+   * Creates a manager to retrieve rows from the database.
+   * @return	a manager supporting plans for processing database rows
+   */
+  RowManager newRowManager();
+
+  /**
+   * Creates a manager for building rules and rules-matching applications.
+   * @return a manager for supporting rules and rule-match operations.
+   */
+  RuleManager newRuleManager();
+
+  /**
+   * Creates a manager for configuring the REST server for the database. The
+   * ServerConfigurationManager can persist query options and transforms or
+   * set properties of the server. The application must have rest-admin
+   * privileges to use the ServerConfigurationManager.
+   *
+   * @return	a manager for the server properties or administrative resources
+   */
+  ServerConfigurationManager newServerConfigManager();
+
+  /** Creates a manager for CRUD operations on semantic graphs.
+   * @return the new GraphManager instance
+   */
+  GraphManager newGraphManager();
+
+  /** Creates a manager for executing SPARQL queries and retrieving results.
+   * @return the new SPARQLQueryManager instance
+   */
+  SPARQLQueryManager newSPARQLQueryManager();
+
+  /**
+   * Creates a PojoRepository specific to the specified class and its id type. 
+   * The PojoRepository provides a facade for persisting, retrieving, and
+   * querying data contained in Java objects.  Annotations are required to
+   * identify the id field and any fields for which you wish to create indexes.
+   *
+   * @param clazz the class type for this PojoRepository to handle
+   * @param idClass the class type of the id field for this clazz, must obviously 
+   *          be Serializable or we'll struggle to marshall it
+   * @param <T> the pojo type this PojoRepository will manage
+   * @param <ID> the scalar type of the id for pojos of type &lt;T&gt;
+   * @return the initialized PojoRepository
+   **/
+  <T, ID extends Serializable> PojoRepository<T, ID> newPojoRepository(Class<T> clazz, Class<ID> idClass);
+
+  /**
+   * Initializes a manager for a extension resource.
+   *
+   * @param resourceName	the name of the extension resource
+   * @param resourceManager	the manager for the extension resource
+   * @param <T> the type of ResourceManager to init for the extension resource
+   * @return	the initialized resource manager
+   */
+  <T extends ResourceManager> T init(String resourceName, T resourceManager);
+
+  /**
+   * Creates a logger for document and query requests.  To merge the logging output
+   * with the output from other loggers, pass the output stream used by the other
+   * loggers.
+   *
+   * @param out	the output stream for the logging output
+   * @return	the logger for client requests
+   */
+  RequestLogger newLogger(OutputStream out);
+
+  /**
+   * Closes the database client and releases associated resources.  After the client is closed,
+   * document and query managers can no longer access the database.
+   */
+  void release();
+
+  /**
+   * Returns the client object from the library that implements communication with the
+   * server.  You should call this method only when you need short-term workarounds such
+   * as configuring communication with the server.  The client implementation object and
+   * library may change without notice or be removed without replacement in a future release.
+   *
+   * In addition, your changes to the configuration of the client implementation object
+   * could impair the operation of the MarkLogic Java Client API.  In short, the client
+   * implementation object should be used only on an interim basis by experts who test
+   * thoroughly to avoid unwanted side effects.
+   *
+   * You can call the getClass().getName() and getClass().getPackage().getName() to discover
+   * the class of the current implementation object.
+   * @return	the object implementing communication with the server 
+   */
+  Object getClientImplementation();
+
+  /**
+   * Creates a ServerEvaluationCall for eval and invoke of server-side xquery or 
+   * javascript code.  Eval requires the xdbc:eval privilege and invoke requires the
+   * xdbc:invoke privilege.  If this DatabaseClient is pointed at a database different
+   * than the default for this REST server, you will need the xdbc:eval-in or xdbc:invoke-in
+   * privilege.
+   * @return the new ServerEvaluationCall instance
+   */
+  ServerEvaluationCall newServerEval();
+
+  String getHost();
+
+  int getPort();
+
+  String getDatabase();
+
+  SecurityContext getSecurityContext();
 }