1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api.services;
20
21 import org.apache.maven.api.Service;
22 import org.apache.maven.api.annotations.Experimental;
23 import org.apache.maven.api.annotations.Nonnull;
24
25 /**
26 * A factory for {@link MessageBuilder}.
27 *
28 * @since 4.0.0
29 */
30 @Experimental
31 public interface MessageBuilderFactory extends Service {
32 /**
33 * Checks if the underlying output does support styling or not.
34 * @return whether color styling is supported or not
35 */
36 boolean isColorEnabled();
37
38 /**
39 * Returns the terminal width or <code>-1</code> if not supported.
40 * @return the terminal width
41 */
42 int getTerminalWidth();
43
44 /**
45 * Creates a new message builder.
46 * @return a new message builder
47 */
48 @Nonnull
49 MessageBuilder builder();
50
51 /**
52 * Creates a new message builder of the specified size.
53 * @param size the initial size of the message builder buffer
54 * @return a new message builder
55 */
56 @Nonnull
57 MessageBuilder builder(int size);
58 }