/*************************************************************************
* Copyright 2014 Eucalyptus Systems, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 3 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*
* Please contact Eucalyptus Systems, Inc., 6755 Hollister Ave., Goleta
* CA 93117, USA or visit http://www.eucalyptus.com/licenses/ if you
* need additional information or have any questions.
*
* This file may incorporate work covered under the following copyright
* and permission notice:
* Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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.eucalyptus.simpleworkflow.common.model;
import static com.eucalyptus.simpleworkflow.common.model.SimpleWorkflowMessage.FieldRegex;
import static com.eucalyptus.simpleworkflow.common.model.SimpleWorkflowMessage.FieldRegexValue;
import java.io.Serializable;
import javax.annotation.Nonnull;
/**
* <p>
* Used to filter the workflow executions in visibility APIs based on a
* tag.
* </p>
*/
public class TagFilter implements Serializable {
/**
* <b>Required.</b> Specifies the tag that must be associated with the
* execution for it to meet the filter criteria.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*/
@Nonnull
@FieldRegex( FieldRegexValue.STRING_256 )
private String tag;
/**
* <b>Required.</b> Specifies the tag that must be associated with the
* execution for it to meet the filter criteria.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @return <b>Required.</b> Specifies the tag that must be associated with the
* execution for it to meet the filter criteria.
*/
public String getTag() {
return tag;
}
/**
* <b>Required.</b> Specifies the tag that must be associated with the
* execution for it to meet the filter criteria.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param tag <b>Required.</b> Specifies the tag that must be associated with the
* execution for it to meet the filter criteria.
*/
public void setTag(String tag) {
this.tag = tag;
}
/**
* <b>Required.</b> Specifies the tag that must be associated with the
* execution for it to meet the filter criteria.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param tag <b>Required.</b> Specifies the tag that must be associated with the
* execution for it to meet the filter criteria.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public TagFilter withTag(String tag) {
this.tag = tag;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTag() != null) sb.append("Tag: " + getTag() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTag() == null) ? 0 : getTag().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof TagFilter == false) return false;
TagFilter other = (TagFilter)obj;
if (other.getTag() == null ^ this.getTag() == null) return false;
if (other.getTag() != null && other.getTag().equals(this.getTag()) == false) return false;
return true;
}
}