com.synopsys.integration.bdio.model.BdioId Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of integration-bdio Show documentation

A library to allow for easy and clear creation of Black Duck I/O (bdio) documents.

The newest version!

/*
 * integration-bdio
 *
 * Copyright (c) 2024 Synopsys, Inc.
 *
 * Use subject to the terms and conditions of the Synopsys End User Software License and Maintenance Agreement. All rights reserved worldwide.
 */
package com.synopsys.integration.bdio.model;

import java.util.Arrays;
import java.util.List;
import java.util.Objects;

import org.apache.commons.lang3.StringUtils;

import com.google.gson.annotations.JsonAdapter;

@JsonAdapter(BdioIdAdapter.class)
public class BdioId {
    public static final String BDIO_ID_SEPARATOR = "/";

    private static final BdioIdEscaper bdioIdEscaper = new BdioIdEscaper();

    private final String id;

    public static BdioId createFromPieces(List pieces) {
        return new BdioId("http:" + StringUtils.join(BdioId.bdioIdEscaper.escapePiecesForUri(pieces), BdioId.BDIO_ID_SEPARATOR));
    }

    public static BdioId createFromPieces(String... pieces) {
        return BdioId.createFromPieces(Arrays.asList(pieces));
    }

    public static BdioId createFromUUID(String uuid) {
        return new BdioId(String.format("uuid:%s", uuid));
    }

    /**
     * Avoid using this constructor - bdio id's have uniqueness and formatting constraints that the static builders handle better.
     * This is mainly for use internally within the library.
     */
    public BdioId(String id) {
        this.id = id;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;
        if (o == null || getClass() != o.getClass())
            return false;
        BdioId bdioId = (BdioId) o;
        return Objects.equals(id, bdioId.id);
    }

    @Override
    public int hashCode() {
        return Objects.hash(id);
    }

    @Override
    public String toString() {
        return id;
    }

}