org.bitcoinj.base.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bitcoinj-core Show documentation

A Java Bitcoin library

There is a newer version: 0.17-beta1

/*
 * Copyright by the original author or authors.
 *
 * 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.
 */

/**
 * The {@code base} package provides fundamental types for bitcoinj. These types must have
 * minimal dependencies. The criteria for allowed dependencies for {@code base} types are:
 * 
 *     No dependencies on other packages of bitcoinj
 *     No API dependencies on external libraries other than the core JDK
 *     Implementation dependencies on Guava are allowed for now (but should be avoided as much as possible)
 * 
 * 
 * Temporary exception: In the 0.17 release, we are allowing some dependencies on other packages, e.g. to
 * {@link org.bitcoinj.core.NetworkParameters} provided that those references are in deprecated methods. This will
 * smooth migration by allowing users to, for example, replace {@code import org.bitcoinj.base.Address} with
 * {@code import org.bitcoinj.core.Address} as first step of conversion and remove usages of the deprecated methods in
 * a second step.
 * 
 * The base package will help us make bitcoinj more modular as we will use it to break circular dependencies
 * between existing packages. We are also considering splitting {@code base} into a separate JAR/module in a
 * future release.
 */
package org.bitcoinj.base;