org.cyclonedx.model.ReleaseNotes Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cyclonedx-core-java Show documentation
Show all versions of cyclonedx-core-java Show documentation
The CycloneDX core module provides a model representation of the BOM along with utilities to assist in creating, parsing, and validating BOMs.
/*
* This file is part of CycloneDX Core (Java).
*
* 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.
*
* SPDX-License-Identifier: Apache-2.0
* Copyright (c) OWASP Foundation. All Rights Reserved.
*/
package org.cyclonedx.model;
import java.util.Date;
import java.util.List;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonUnwrapped;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import org.cyclonedx.Version;
import org.cyclonedx.model.component.Tags;
import org.cyclonedx.util.deserializer.NotesDeserializer;
import org.cyclonedx.util.deserializer.PropertiesDeserializer;
import org.cyclonedx.util.deserializer.ResolvesDeserializer;
import org.cyclonedx.util.deserializer.StringListDeserializer;
import org.cyclonedx.util.serializer.CustomDateSerializer;
/**
* @since 6.0.0
*/
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@JsonPropertyOrder({
"type",
"title",
"featuredImage",
"socialImage",
"description",
"timestamp",
"aliases",
"tags",
"resolves",
"notes",
"properties"
})
public class ReleaseNotes
{
public ReleaseNotes() {}
private String type;
private String title;
private String featuredImage;
private String socialImage;
private String description;
@JsonSerialize(using = CustomDateSerializer.class)
@VersionFilter(Version.VERSION_14)
private Date timestamp;
private List aliases;
@JsonUnwrapped
private Tags tags;
private List resolves;
private List notes;
private List properties;
public String getType() {
return type;
}
public void setType(final String type) {
this.type = type;
}
public String getTitle() {
return title;
}
public void setTitle(final String title) {
this.title = title;
}
public String getFeaturedImage() {
return featuredImage;
}
public void setFeaturedImage(final String featuredImage) {
this.featuredImage = featuredImage;
}
public String getSocialImage() {
return socialImage;
}
public void setSocialImage(final String socialImage) {
this.socialImage = socialImage;
}
public String getDescription() {
return description;
}
public void setDescription(final String description) {
this.description = description;
}
public Date getTimestamp() {
return timestamp;
}
public void setTimestamp(final Date timestamp) {
this.timestamp = timestamp;
}
@JacksonXmlElementWrapper(localName = "aliases")
@JacksonXmlProperty(localName = "alias")
@JsonDeserialize(using = StringListDeserializer.class)
public List getAliases() {
return aliases;
}
public void setAliases(final List aliases) {
this.aliases = aliases;
}
public Tags getTags() {
return tags;
}
public void setTags(final Tags tags) {
this.tags = tags;
}
@JacksonXmlElementWrapper(localName = "resolves")
@JacksonXmlProperty(localName = "issue")
@JsonDeserialize(using = ResolvesDeserializer.class)
public List getResolves() {
return resolves;
}
public void setResolves(final List resolves) {
this.resolves = resolves;
}
@JacksonXmlElementWrapper(localName = "notes")
@JacksonXmlProperty(localName = "note")
@JsonDeserialize(using = NotesDeserializer.class)
public List getNotes() {
return notes;
}
public void setNotes(final List notes) {
this.notes = notes;
}
@JacksonXmlElementWrapper(localName = "properties")
@JacksonXmlProperty(localName = "property")
@JsonDeserialize(using = PropertiesDeserializer.class)
public List getProperties() {
return properties;
}
public void setProperties(final List properties) {
this.properties = properties;
}
public static class Resolves {
public enum Type {
@JsonProperty("defect")
DEFECT("defect"),
@JsonProperty("enhancement")
ENHANCEMENT("enhancement"),
@JsonProperty("security")
SECURITY("security");
private final String name;
public String getResolvesName() {
return this.name;
}
Type(String name) {
this.name = name;
}
public static Resolves.Type fromString(String text) {
for (Resolves.Type t : Resolves.Type.values()) {
if (t.name.equals(text)) {
return t;
}
}
return null;
}
}
@JacksonXmlProperty(isAttribute = true)
private Type type;
private String id;
private String name;
private String description;
private Source source;
@JacksonXmlElementWrapper(localName = "references")
@JacksonXmlProperty(localName = "url")
private List references;
public Type getType() {
return type;
}
public void setType(final Type type) {
this.type = type;
}
public String getId() {
return id;
}
public void setId(final String id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(final String name) {
this.name = name;
}
public String getDescription() {
return description;
}
public void setDescription(final String description) {
this.description = description;
}
public Source getSource() {
return source;
}
public void setSource(final Source source) {
this.source = source;
}
public List getReferences() {
return references;
}
public void setReferences(final List references) {
this.references = references;
}
}
public static class Notes {
@JsonProperty("locale")
private String locale;
@JsonProperty("text")
private AttachmentText text;
public String getLocale() {
return locale;
}
public void setLocale(final String locale) {
this.locale = locale;
}
public AttachmentText getText() {
return text;
}
public void setText(final AttachmentText text) {
this.text = text;
}
}
@Override
public boolean equals(final Object object) {
if (this == object) {
return true;
}
if (!(object instanceof ReleaseNotes)) {
return false;
}
ReleaseNotes that = (ReleaseNotes) object;
return Objects.equals(type, that.type) && Objects.equals(title, that.title) &&
Objects.equals(featuredImage, that.featuredImage) &&
Objects.equals(socialImage, that.socialImage) &&
Objects.equals(description, that.description) && Objects.equals(timestamp, that.timestamp) &&
Objects.equals(aliases, that.aliases) && Objects.equals(tags, that.tags) &&
Objects.equals(resolves, that.resolves) && Objects.equals(notes, that.notes) &&
Objects.equals(properties, that.properties);
}
@Override
public int hashCode() {
return Objects.hash(type, title, featuredImage, socialImage, description, timestamp, aliases, tags, resolves, notes,
properties);
}
}