001/*
002 * Copyright 2002-2012 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.beans.factory.parsing;
018
019import org.springframework.util.Assert;
020
021/**
022 * {@link ParseState} entry representing a (possibly indexed)
023 * constructor argument.
024 *
025 * @author Rob Harrop
026 * @author Juergen Hoeller
027 * @since 2.0
028 */
029public class ConstructorArgumentEntry implements ParseState.Entry {
030
031        private final int index;
032
033
034        /**
035         * Creates a new instance of the {@link ConstructorArgumentEntry} class
036         * representing a constructor argument with a (currently) unknown index.
037         */
038        public ConstructorArgumentEntry() {
039                this.index = -1;
040        }
041
042        /**
043         * Creates a new instance of the {@link ConstructorArgumentEntry} class
044         * representing a constructor argument at the supplied {@code index}.
045         * @param index the index of the constructor argument
046         * @throws IllegalArgumentException if the supplied {@code index}
047         * is less than zero
048         */
049        public ConstructorArgumentEntry(int index) {
050                Assert.isTrue(index >= 0, "Constructor argument index must be greater than or equal to zero");
051                this.index = index;
052        }
053
054
055        @Override
056        public String toString() {
057                return "Constructor-arg" + (this.index >= 0 ? " #" + this.index : "");
058        }
059
060}