001/*
002 * Copyright 2002-2007 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 *      https://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.jmx.export.metadata;
018
019/**
020 * Metadata about JMX operation parameters.
021 * Used in conjunction with a {@link ManagedOperation} attribute.
022 *
023 * @author Rob Harrop
024 * @since 1.2
025 */
026public class ManagedOperationParameter {
027
028        private int index = 0;
029
030        private String name = "";
031
032        private String description = "";
033
034
035        /**
036         * Set the index of this parameter in the operation signature.
037         */
038        public void setIndex(int index) {
039                this.index = index;
040        }
041
042        /**
043         * Return the index of this parameter in the operation signature.
044         */
045        public int getIndex() {
046                return this.index;
047        }
048
049        /**
050         * Set the name of this parameter in the operation signature.
051         */
052        public void setName(String name) {
053                this.name = name;
054        }
055
056        /**
057         * Return the name of this parameter in the operation signature.
058         */
059        public String getName() {
060                return this.name;
061        }
062
063        /**
064         * Set a description for this parameter.
065         */
066        public void setDescription(String description) {
067                this.description = description;
068        }
069
070        /**
071         * Return a description for this parameter.
072         */
073        public String getDescription() {
074                return this.description;
075        }
076
077}