de.codesourcery.versiontracker.common.ArtifactResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of versiontracker-common Show documentation
There is a newer version: 1.0.28
Show newest version
/**
 * Copyright 2018 Tobias Gierke 
 *
 * 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 de.codesourcery.versiontracker.common;

import de.codesourcery.versiontracker.common.server.SerializationFormat;

import java.io.IOException;
import java.util.Objects;

/**
 * Response for a single artifact from a {@link QueryRequest}.
 *
 * @author [email protected]
 */
public class ArtifactResponse 
{
    /**
     * Status that indicates whether a newer version of the given artifact is available.
     *
     * @author [email protected]
     */
	public enum UpdateAvailable
	{
	    /**
	     * A later version of the queried artifact is available.
	     */
		YES("yes"),
        /**
         * No later version of the queried artifact is available.
         */		
		NO("no"),
        /**
         * For some reason the server was unable to figure out whether
         * a later version was available (maybe because the version number syntax
         * was not recognized and thus comparison failed).
         */ 		
		MAYBE("maybe"),
		/**
		 * The artifact was not found in any repository.
		 */
		NOT_FOUND("not_found");
		
		public final String text;

		UpdateAvailable(String text) {
			this.text = text;
		}
		
		public static UpdateAvailable fromString(String s)
		{
			for ( UpdateAvailable v : values() ) {
				if ( v.text.equals(s) ) {
					return v;
				}
			}
			return UpdateAvailable.NOT_FOUND;
		}
	}

	public Artifact artifact;
	public Version currentVersion;
	// TODO: This is actually the latest non-snapshot version that is not blacklisted by the client
	public Version latestVersion;
	public UpdateAvailable updateAvailable;

	@Override
	public boolean equals(Object obj) {
		if ( obj instanceof ArtifactResponse o ) {
			if ( ! Objects.equals(this.artifact,o.artifact) ) {
				return false;
			}
			if ( currentVersion == null || o.currentVersion == null ) {
				if ( currentVersion != o.currentVersion ) {
					return false;
				}
			} else {
				if ( ! Version.sameFields(this.currentVersion, o.currentVersion ) ) {
					return false;
				}
			}
			if ( latestVersion == null || o.latestVersion == null ) {
				if ( latestVersion != o.latestVersion ) {
					return false;
				}
			} else {
				if ( ! Version.sameFields(this.latestVersion, o.latestVersion ) ) {
					return false;
				}
			}			
			return Objects.equals(this.updateAvailable, o.updateAvailable);
		}
		return false;
	}
	
    public void serialize(BinarySerializer serializer, SerializationFormat fileFormat) throws IOException
    {
        artifact.serialize( serializer );
        
        if ( currentVersion != null ) {
            serializer.writeBoolean( true );
            currentVersion.serialize( serializer, fileFormat);
        } else {
            serializer.writeBoolean( false );
        }
        
        if ( latestVersion != null ) {
            serializer.writeBoolean( true );
            latestVersion.serialize( serializer, fileFormat );
        } else {
            serializer.writeBoolean( false );
        }

        serializer.writeString( updateAvailable == null ? null : updateAvailable.text );
    }
    
    public static ArtifactResponse deserialize(BinarySerializer serializer, SerializationFormat fileFormat) throws IOException
	{
        final ArtifactResponse response = new ArtifactResponse();
        response.artifact = Artifact.deserialize(serializer);
        
        boolean isPresent = serializer.readBoolean();
        if ( isPresent ) {
            response.currentVersion = Version.deserialize(serializer, fileFormat);
        }
        isPresent = serializer.readBoolean();
        if ( isPresent ) {
            response.latestVersion = Version.deserialize(serializer, fileFormat);
        }
        final String updAvailable = serializer.readString();
        response.updateAvailable = updAvailable == null ? null : UpdateAvailable.fromString( updAvailable );
        return response;
    }
    
	@Override
	public String toString() {
	    return "ArtifactResponse[ updateAvailable: "+updateAvailable+", current_version: "+currentVersion+" latest_version: "+latestVersion+", artifact: "+artifact+" ]";
	}
	
	public boolean hasCurrentVersion() {
	    return currentVersion != null;
	}
	
    public boolean hasLatestVersion() {
        return latestVersion != null;
    }	
}