/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.controller.descriptions;
import java.util.Locale;
import org.jboss.dmr.ModelNode;
/**
* Provides information (description, list of attributes, list of children)
* describing the structure of an addressable model node or operation.
*
* @author Brian Stansberry
*/
public interface DescriptionProvider {
/**
* Gets the descriptive information (human-friendly description, list of attributes,
* list of children) describing a single model node or operation.
* <p>
* The implementation must assume that the caller intends to modify the
* returned {@code ModelNode} so it should not hand out a reference to any internal data structures.
*
* @param locale the locale to use to generate any localized text used in the description.
* May be {@code null}, in which case {@link Locale#getDefault()} should be used
*
* @return {@link ModelNode} describing the model node's structure
*/
ModelNode getModelDescription(Locale locale);
}