001/* 002 * Copyright 2012-2018 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.boot.actuate.endpoint.jmx; 018 019/** 020 * Describes the parameters of an operation on a JMX endpoint. 021 * 022 * @author Stephane Nicoll 023 * @author Phillip Webb 024 * @since 2.0.0 025 */ 026public interface JmxOperationParameter { 027 028 /** 029 * Return the name of the operation parameter. 030 * @return the name of the parameter 031 */ 032 String getName(); 033 034 /** 035 * Return the type of the operation parameter. 036 * @return the type 037 */ 038 Class<?> getType(); 039 040 /** 041 * Return the description of the parameter or {@code null} if none is available. 042 * @return the description or {@code null} 043 */ 044 String getDescription(); 045 046}