/*
* Copyright (C) 2009 The Android Open Source Project
*
* 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.
*/
package com.android.sdkuilib.internal.repository;
import com.android.sdklib.internal.repository.Archive;
import com.android.sdklib.internal.repository.IDescription;
import com.android.sdklib.internal.repository.Package;
import java.util.ArrayList;
import java.util.Collection;
/**
* Represents an archive that we want to install.
* Note that the installer deals with archives whereas the user mostly sees packages
* but as far as we are concerned for installation there's a 1-to-1 mapping.
* <p/>
* A new archive is always a remote archive that needs to be downloaded and then
* installed. It can replace an existing local one. It can also depends on another
* (new or local) archive, which means the dependent archive needs to be successfully
* installed first. Finally this archive can also be a dependency for another one.
* <p/>
* The accepted and rejected flags are used by {@link UpdateChooserDialog} to follow
* user choices. The installer should never install something that is not accepted.
* <p/>
* <em>Note</em>: There is currently no logic to support more than one level of
* dependency, either here or in the {@link UpdateChooserDialog}, since we currently
* have no need for it.
*
* @see ArchiveInfo#ArchiveInfo(Archive, Archive, ArchiveInfo[])
*/
class ArchiveInfo implements IDescription, Comparable<ArchiveInfo> {
private final Archive mNewArchive;
private final Archive mReplaced;
private final ArchiveInfo[] mDependsOn;
private final ArrayList<ArchiveInfo> mDependencyFor = new ArrayList<ArchiveInfo>();
private boolean mAccepted;
private boolean mRejected;
/**
*
* @param newArchive A "new archive" to be installed. This is always an archive
* that comes from a remote site. This <em>may</em> be null.
* @param replaced An optional local archive that the new one will replace.
* Can be null if this archive does not replace anything.
* @param dependsOn An optional new or local dependency, that is an archive that
* <em>this</em> archive depends upon. In other words, we can only install
* this archive if the dependency has been successfully installed. It also
* means we need to install the dependency first. Can be null or empty.
* However it cannot contain nulls.
*/
public ArchiveInfo(Archive newArchive, Archive replaced, ArchiveInfo[] dependsOn) {
mNewArchive = newArchive;
mReplaced = replaced;
mDependsOn = dependsOn;
}
/**
* Returns the "new archive" to be installed.
* This <em>may</em> be null for missing archives.
*/
public Archive getNewArchive() {
return mNewArchive;
}
/**
* Returns an optional local archive that the new one will replace.
* Can be null if this archive does not replace anything.
*/
public Archive getReplaced() {
return mReplaced;
}
/**
* Returns an optional new or local dependency, that is an archive that <em>this</em>
* archive depends upon. In other words, we can only install this archive if the
* dependency has been successfully installed. It also means we need to install the
* dependency first.
* <p/>
* This array can be null or empty. It can't contain nulls though.
*/
public ArchiveInfo[] getDependsOn() {
return mDependsOn;
}
/**
* Returns true if this new archive is a dependency for <em>another</em> one that we
* want to install.
*/
public boolean isDependencyFor() {
return mDependencyFor.size() > 0;
}
/**
* Adds an {@link ArchiveInfo} for which <em>this</em> package is a dependency.
* This means the package added here depends on this package.
*/
public ArchiveInfo addDependencyFor(ArchiveInfo dependencyFor) {
if (!mDependencyFor.contains(dependencyFor)) {
mDependencyFor.add(dependencyFor);
}
return this;
}
/**
* Returns the list of {@link ArchiveInfo} for which <em>this</em> package is a dependency.
* This means the packages listed here depend on this package.
* <p/>
* Implementation detail: this is the internal mutable list. Callers should not modify it.
* This list can be empty but is never null.
*/
public Collection<ArchiveInfo> getDependenciesFor() {
return mDependencyFor;
}
/**
* Sets whether this archive was accepted (either manually by the user or
* automatically if it doesn't have a license) for installation.
*/
public void setAccepted(boolean accepted) {
mAccepted = accepted;
}
/**
* Returns whether this archive was accepted (either manually by the user or
* automatically if it doesn't have a license) for installation.
*/
public boolean isAccepted() {
return mAccepted;
}
/**
* Sets whether this archive was rejected manually by the user.
* An archive can neither accepted nor rejected.
*/
public void setRejected(boolean rejected) {
mRejected = rejected;
}
/**
* Returns whether this archive was rejected manually by the user.
* An archive can neither accepted nor rejected.
*/
public boolean isRejected() {
return mRejected;
}
/**
* Returns the long description of the parent package of the new archive, if not null.
* Otherwise returns an empty string.
*/
public String getLongDescription() {
if (mNewArchive != null) {
Package p = mNewArchive.getParentPackage();
if (p != null) {
return p.getLongDescription();
}
}
return "";
}
/**
* Returns the short description of the parent package of the new archive, if not null.
* Otherwise returns an empty string.
*/
public String getShortDescription() {
if (mNewArchive != null) {
Package p = mNewArchive.getParentPackage();
if (p != null) {
return p.getShortDescription();
}
}
return "";
}
/**
* Returns the short description of the parent package of the new archive, if not null.
* Otherwise returns the default Object toString result.
* <p/>
* This is mostly helpful for debugging. For UI display, use the {@link IDescription}
* interface.
*/
@Override
public String toString() {
if (mNewArchive != null) {
Package p = mNewArchive.getParentPackage();
if (p != null) {
return p.getShortDescription();
}
}
return super.toString();
}
/**
* ArchiveInfos are compared using ther "new archive" ordering.
*
* @see Archive#compareTo(Archive)
*/
public int compareTo(ArchiveInfo rhs) {
if (mNewArchive != null && rhs != null) {
return mNewArchive.compareTo(rhs.getNewArchive());
}
return 0;
}
}