io.objectbox.sync.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of objectbox-java Show documentation

ObjectBox is a fast NoSQL database for Objects

The newest version!

/*
 * Copyright 2020 ObjectBox Ltd. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * ObjectBox Sync allows to automatically synchronize local data with a sync
 * destination (e.g. a sync server) and vice versa. This is the sync client package.
 * 
 * These are the typical steps to setup a sync client:
 * 

 *     Create a BoxStore as usual (using MyObjectBox).
 *     Get a {@link io.objectbox.sync.SyncBuilder} using
 *     {@link io.objectbox.sync.Sync#client(io.objectbox.BoxStore, java.lang.String, io.objectbox.sync.SyncCredentials) Sync.client(boxStore, url, credentials)}.
 *     Here you need to pass the {@link io.objectbox.BoxStore BoxStore}, along with an URL to the sync destination (server),
 *     and credentials. For demo set ups, you could start with {@link io.objectbox.sync.SyncCredentials#none()}
 *     credentials.
 *     Optional: use the {@link io.objectbox.sync.SyncBuilder} instance from the last step to configure the sync
 *     client and set initial listeners.
 *     Call {@link io.objectbox.sync.SyncBuilder#build()} to get an instance of
 *     {@link io.objectbox.sync.SyncClient} (and hold on to it). Synchronization is now active.
 *     Optional: Interact with {@link io.objectbox.sync.SyncClient}.
 * 
 */
@ParametersAreNonnullByDefault
package io.objectbox.sync;

import javax.annotation.ParametersAreNonnullByDefault;