001: package org.apache.maven.embedder;
002:
003: /*
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021:
022: import org.apache.maven.settings.Settings;
023:
024: /**
025: * @author Jason van Zyl
026: * TODO remove deprecated methods
027: */
028: public interface ConfigurationValidationResult {
029: /**
030: * Whether both user and global settings are valid
031: */
032: boolean isValid();
033:
034: /**
035: * Parsed user settings. If there's any parse error, it can be retrieved through
036: * {@link #getUserSettingsException()}
037: */
038: Settings getUserSettings();
039:
040: /**
041: * Parsed global settings. If there's any parse error, it can be retrieved through
042: * {@link #getGlobalSettingsException()}
043: */
044: Settings getGlobalSettings();
045:
046: /**
047: * Any exception that happened during parsing user settings, or null if there were no errors.
048: */
049: Exception getUserSettingsException();
050:
051: /**
052: * Any exception that happened during parsing global settings, or null if there were no errors.
053: */
054: Exception getGlobalSettingsException();
055:
056: /**
057: * @deprecated
058: */
059: boolean isUserSettingsFilePresent();
060:
061: /**
062: * @deprecated
063: */
064: void setUserSettingsFilePresent(boolean userSettingsFilePresent);
065:
066: /**
067: * @deprecated
068: */
069: boolean isUserSettingsFileParses();
070:
071: /**
072: * @deprecated
073: */
074: void setUserSettingsFileParses(boolean userSettingsFileParses);
075:
076: /**
077: * @deprecated
078: */
079: boolean isGlobalSettingsFilePresent();
080:
081: /**
082: * @deprecated
083: */
084: void setGlobalSettingsFilePresent(boolean globalSettingsFilePresent);
085:
086: /**
087: * @deprecated
088: */
089: boolean isGlobalSettingsFileParses();
090:
091: /**
092: * @deprecated
093: */
094: void setGlobalSettingsFileParses(boolean globalSettingsFileParses);
095:
096: /**
097: * @deprecated
098: */
099: void display();
100: }
|