io.restassured.internal.http.Status Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-assured Show documentation

Java DSL for easy testing of REST services

There is a newer version: 5.5.0

/*
 * Copyright 2019 the original author or authors.
 *
 * 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 io.restassured.internal.http;

/**
 * Mapping of HTTP response codes to a constant 'success' or 'failure' value.
 * @author Tom Nichols
 */
public enum Status {
	/** Any status code >= 100 and < 400 */
	SUCCESS ( 100, 399 ),
	/** Any status code >= 400 and < 1000 */
	FAILURE ( 400, 999 );

	private final int min, max;
	
	@Override public String toString() {
		return super.toString().toLowerCase();
	}
	
	/**
	 * Returns true if the numeric code matches the represented status (either 
	 * success or failure).  i.e.
	 * 	 * assert Status.SUCCESS.matches(200);
	 * assert Status.FAILURE.matches(404);
	 * 
	 * @param code numeric HTTP code
	 * @return true if the numeric code represents this enums success or failure
	 *   condition
	 */
	public boolean matches( int code ) {
		return min <= code && code <= max;
	}
	
	/**
	 * Find the Status value that matches the given status code. 
	 * @param code HTTP response code
	 * @return a 'success' or 'failure' Status value
	 * @throws IllegalArgumentException if the given code is not a valid HTTP
	 *   status code.
	 */
	public static Status find( int code ) {
		for ( Status s : Status.values() ) 
			if ( s.matches( code ) ) return s;
		throw new IllegalArgumentException( "Unknown status: " + code );
	}
	
	private Status( int min, int max ) {
		this.min = min; this.max = max;
	}
}