PortStatusSnapshotEntity.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.nifi.web.api.entity;

import com.wordnik.swagger.annotations.ApiModelProperty;
import org.apache.nifi.web.api.dto.ReadablePermission;
import org.apache.nifi.web.api.dto.status.PortStatusSnapshotDTO;

/**
 * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a
 * PortStatusSnapshotDTO.
 */
public class PortStatusSnapshotEntity extends Entity implements ReadablePermission {
    private String id;
    private PortStatusSnapshotDTO portStatusSnapshot;
    private Boolean canRead;

    /**
     * @return The port id
     */
    @ApiModelProperty("The id of the port.")
    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    /**
     * The PortStatusSnapshotDTO that is being serialized.
     *
     * @return The PortStatusSnapshotDTO object
     */
    public PortStatusSnapshotDTO getPortStatusSnapshot() {
        return portStatusSnapshot;
    }

    public void setPortStatusSnapshot(PortStatusSnapshotDTO portStatusSnapshot) {
        this.portStatusSnapshot = portStatusSnapshot;
    }

    @Override
    public Boolean getCanRead() {
        return canRead;
    }

    @Override
    public void setCanRead(Boolean canRead) {
        this.canRead = canRead;
    }

    @Override
    public PortStatusSnapshotEntity clone() {
        final PortStatusSnapshotEntity other = new PortStatusSnapshotEntity();
        other.setCanRead(this.getCanRead());
        other.setPortStatusSnapshot(this.getPortStatusSnapshot().clone());

        return other;
    }
}