Skip to content

Driver versioning and renaming #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 23, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import java.io.File;
import java.util.logging.Level;

import org.neo4j.driver.internal.logging.JULogging;
import org.neo4j.driver.internal.spi.Logging;
import org.neo4j.driver.v1.internal.logging.JULogging;
import org.neo4j.driver.v1.internal.spi.Logging;

import static org.neo4j.driver.Config.TlsAuthenticationConfig.*;
import static org.neo4j.driver.v1.Config.TlsAuthenticationConfig.*;

/**
* A configuration class to config driver properties.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* An item that can be considered to have <em>direction</em>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import java.net.URI;

import org.neo4j.driver.internal.StandardSession;
import org.neo4j.driver.internal.pool.StandardConnectionPool;
import org.neo4j.driver.internal.spi.ConnectionPool;
import org.neo4j.driver.v1.internal.StandardSession;
import org.neo4j.driver.v1.internal.pool.StandardConnectionPool;
import org.neo4j.driver.v1.internal.spi.ConnectionPool;

/**
* A Neo4j database driver, through which you can create {@link Session sessions} to run statements against the database.
Expand All @@ -40,7 +40,7 @@
* session.run( "CREATE (n {name:'Bob'})" );
*
* // Or, run multiple statements together in an atomic transaction:
* try( Transaction tx = session.newTransaction() )
* try( Transaction tx = session.beginTransaction() )
* {
* tx.run( "CREATE (n {name:'Alice'})" );
* tx.run( "CREATE (n {name:'Tina'})" );
Expand Down Expand Up @@ -84,7 +84,7 @@ public Driver( URI url, Config config )
/**
* Establish a session
* @return a session that could be used to run {@link Session#run(String) a statement} or
* {@link Session#newTransaction() a transaction }.
* {@link Session#beginTransaction() a transaction }.
*/
public Session session()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* A uniquely identifiable property container that can form part of a Neo4j graph.
*/
public interface Entity
{
/**
* A unique {@link org.neo4j.driver.Identity identity} for this Entity. Identities are guaranteed
* A unique {@link Identity identity} for this Entity. Identities are guaranteed
* to remain stable for the duration of the session they were found in, but may be re-used for other
* entities after that. As such, if you want a public identity to use for your entities, attaching
* an explicit 'id' property or similar persistent and unique identifier is a better choice.
Expand All @@ -48,7 +48,7 @@ public interface Entity
int propertyCount();

/**
* Return a specific property {@link org.neo4j.driver.Value}. If no value could be found with the specified key,
* Return a specific property {@link Value}. If no value could be found with the specified key,
* null will be returned.
*
* @param key a property key
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* Same as {@link java.util.function.Function}, but defined here to work in versions older than java 8.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import java.net.URI;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* A unique identifier for an {@link org.neo4j.driver.Entity}.
* A unique identifier for an {@link Entity}.
* <p>
* The identity can be used to correlate entities in one response with entities received earlier. The identity of an
* entity is guaranteed to be stable within the scope of a session. Beyond that, the identity may change. If you want
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* An input position refers to a specific character in a statement.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* The <strong>Node</strong> interface describes the characteristics of a node from a Neo4j graph.
Expand All @@ -29,5 +29,4 @@ public interface Node extends Entity
* @return a label Collection
*/
Iterable<String> labels();

}
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* Representation for notifications found when executing a statement.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* A <strong>Path</strong> is a directed sequence of relationships between two nodes. This generally
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import java.util.List;
import java.util.Map;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import java.util.List;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* A record is a collection of named fields, and is what makes up the individual items in a {@link
* org.neo4j.driver.Result}
* Result}
*/
public interface Record
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* The <strong>Relationship</strong> interface describes the characteristics of a relationship from a Neo4j graph.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import org.neo4j.driver.v1.exceptions.ClientException;

/**
* The result of running a statement, a stream of records. The result interface can be used to iterate over all the
Expand All @@ -36,7 +38,7 @@ public interface Result
*
* This cannot be used if you have already started iterating through the stream using {@link #next()}.
*
* @return {@link org.neo4j.driver.ReusableResult}
* @return {@link ReusableResult}
*/
ReusableResult retain();

Expand Down Expand Up @@ -83,7 +85,7 @@ public interface Result
* </pre>
*
* @return a single record from the stream
* @throws org.neo4j.driver.exceptions.ClientException if the stream is empty
* @throws ClientException if the stream is empty
*/
Record single();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import java.util.List;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* A {@link Result} that has been fully retrieved and stored from the server.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* A live session with a Neo4j instance.
Expand Down Expand Up @@ -45,8 +45,8 @@ public interface Session extends AutoCloseable, StatementRunner
*
* @return a new transaction
*/
Transaction newTransaction();
Transaction beginTransaction();

@Override
void close();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,24 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import org.neo4j.driver.internal.ParameterSupport;
import org.neo4j.driver.v1.internal.ParameterSupport;

import static java.lang.String.format;

/**
* An executable statement, i.e. the statements' text and its parameters.
*
* @see org.neo4j.driver.Session
* @see org.neo4j.driver.Transaction
* @see org.neo4j.driver.Result
* @see org.neo4j.driver.Result#summarize()
* @see org.neo4j.driver.ResultSummary
* @see Session
* @see Transaction
* @see Result
* @see Result#summarize()
* @see ResultSummary
*/
public class Statement
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import java.util.Map;

/**
* Common interface for components that can execute Neo4j statements.
*
* @see org.neo4j.driver.Session
* @see org.neo4j.driver.Transaction
* @see Session
* @see Transaction
*/
public interface StatementRunner
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import org.neo4j.driver.exceptions.ClientException;
import org.neo4j.driver.v1.exceptions.ClientException;

public enum StatementType
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* Represents a transaction in the Neo4j database.
Expand All @@ -29,7 +29,7 @@
*
* <pre class="docTest:TransactionDocIT#classDoc">
* {@code
* try( Transaction tx = session.newTransaction() )
* try( Transaction tx = session.beginTransaction() )
* {
* tx.run( "CREATE (n)" );
* tx.success();
Expand All @@ -56,7 +56,7 @@ public interface Transaction extends AutoCloseable, StatementRunner
*
* <pre class="docTest:TransactionDocIT#failure">
* {@code
* try(Transaction tx = session.newTransaction() )
* try(Transaction tx = session.beginTransaction() )
* {
* tx.run( "CREATE (n)" );
* tx.failure();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

/**
* Contains counters for the number of update operations performed by a statement.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.driver;
package org.neo4j.driver.v1;

import java.util.List;
import java.util.Map;
Expand All @@ -34,7 +34,7 @@
* <h2>Navigating a tree structure</h2>
*
* Because Neo4j often handles dynamic structures, this interface is designed to help
* you handle such structures in Java. Specifically, {@link org.neo4j.driver.Value} lets you navigate arbitrary tree
* you handle such structures in Java. Specifically, {@link Value} lets you navigate arbitrary tree
* structures without having to resort to type casting.
*
* Given a tree structure like:
Expand Down
Loading