# LineBreakConfig.Builder

Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Builder

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/graphics/text/LineBreakConfig.Builder "View this page in Java")  

```
class Builder
```

|---|------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                 ||
| ↳ | [android.graphics.text.LineBreakConfig.Builder](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#) |

A builder for creating a`LineBreakConfig`instance.

## Summary

|                                                              Public constructors                                                              ||
|--------------------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#Builder())`()` Builder constructor. |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       Public methods                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ||
|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [LineBreakConfig](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig)                  | [build](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#build())`()` Builds a[LineBreakConfig](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig)instance.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| [LineBreakConfig.Builder](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#) | [merge](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#merge(android.graphics.text.LineBreakConfig))`(`config:` `[LineBreakConfig](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig)`)` Merges line break config with other config Update the internal configurations with passed`config`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| [LineBreakConfig.Builder](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#) | [setHyphenation](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#setHyphenation(kotlin.Int))`(`hyphenation:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the hyphenation preference Note: Even if the[LineBreakConfig.HYPHENATION_ENABLED](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#HYPHENATION_ENABLED:kotlin.Int)is specified, the hyphenation will not be performed if the[android.widget.TextView](https://developer.android.com/reference/kotlin/android/widget/TextView.html#)or underlying[android.text.StaticLayout](https://developer.android.com/reference/kotlin/android/text/StaticLayout.html#),[LineBreaker](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreaker)are configured with[LineBreaker.HYPHENATION_FREQUENCY_NONE](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreaker#HYPHENATION_FREQUENCY_NONE:kotlin.Int). |
| [LineBreakConfig.Builder](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#) | [setLineBreakStyle](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#setLineBreakStyle(kotlin.Int))`(`lineBreakStyle:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the line-break style.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| [LineBreakConfig.Builder](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#) | [setLineBreakWordStyle](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#setLineBreakWordStyle(kotlin.Int))`(`lineBreakWordStyle:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the line-break word style.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

## Public constructors

### Builder

Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
Builder()
```

Builder constructor.

## Public methods

### build

Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun build(): LineBreakConfig
```

Builds a[LineBreakConfig](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig)instance. This method can be called multiple times for generating multiple[LineBreakConfig](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig)instances.

|                                                                               Return                                                                               ||
|---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|
| [LineBreakConfig](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig) | The`LineBreakConfig`instance. This value cannot be`null`. |

### merge

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun merge(config: LineBreakConfig): LineBreakConfig.Builder
```

Merges line break config with other config Update the internal configurations with passed`config`. If the config values of passed`config`are unspecified, the original config values are kept. For example, the following code passes`config`that has[LINE_BREAK_STYLE_UNSPECIFIED](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_STYLE_UNSPECIFIED:kotlin.Int). This code generates[LineBreakConfig](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig)that has line break config[LINE_BREAK_STYLE_STRICT](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_STYLE_STRICT:kotlin.Int).  

```kotlin
val override = LineBreakConfig.Builder()
           .setLineBreakWordStyle(LineBreakConfig.LINE_BREAK_WORD_STYLE_PHRASE)
           .build();  // UNSPECIFIED if no setLineBreakStyle is called.
      val config = LineBreakConfig.Builder()
           .setLineBreakStyle(LineBreakConfig.LINE_BREAK_STYLE_STRICT)
           .merge(override)
           .build()
      // Here, config has LINE_BREAK_STYLE_STRICT of line break config and
      // LINE_BREAK_WORD_STYLE_PHRASE of line break word style.
  
```

<br />

|                                                                                 Parameters                                                                                  ||
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `config` | [LineBreakConfig](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig):an override line break config This value cannot be`null`. |

|                                                                                Return                                                                                ||
|--------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| [LineBreakConfig.Builder](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#) | This`Builder`. This value cannot be`null`. |

**See Also**

- [#LINE_BREAK_STYLE_UNSPECIFIED](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_STYLE_UNSPECIFIED:kotlin.Int)
- [#LINE_BREAK_WORD_STYLE_UNSPECIFIED](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_WORD_STYLE_UNSPECIFIED:kotlin.Int)  

### setHyphenation

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setHyphenation(hyphenation: Int): LineBreakConfig.Builder
```

Sets the hyphenation preference Note: Even if the[LineBreakConfig.HYPHENATION_ENABLED](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#HYPHENATION_ENABLED:kotlin.Int)is specified, the hyphenation will not be performed if the[android.widget.TextView](https://developer.android.com/reference/kotlin/android/widget/TextView.html#)or underlying[android.text.StaticLayout](https://developer.android.com/reference/kotlin/android/text/StaticLayout.html#),[LineBreaker](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreaker)are configured with[LineBreaker.HYPHENATION_FREQUENCY_NONE](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreaker#HYPHENATION_FREQUENCY_NONE:kotlin.Int). Note: Even if the hyphenation is enabled with a line break strategy[LineBreaker.BREAK_STRATEGY_SIMPLE](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreaker#BREAK_STRATEGY_SIMPLE:kotlin.Int), the hyphenation will not be performed unless a single word cannot meet width constraints.

|                                                                                                                                                                                                                                                                                                                                          Parameters                                                                                                                                                                                                                                                                                                                                           ||
|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `hyphenation` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The hyphenation preference. Value is[android.graphics.text.LineBreakConfig#HYPHENATION_UNSPECIFIED](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#HYPHENATION_UNSPECIFIED:kotlin.Int),[android.graphics.text.LineBreakConfig#HYPHENATION_ENABLED](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#HYPHENATION_ENABLED:kotlin.Int), or[android.graphics.text.LineBreakConfig#HYPHENATION_DISABLED](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#HYPHENATION_DISABLED:kotlin.Int) |

|                                                                                Return                                                                                ||
|--------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| [LineBreakConfig.Builder](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#) | This`Builder`. This value cannot be`null`. |

### setLineBreakStyle

Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setLineBreakStyle(lineBreakStyle: Int): LineBreakConfig.Builder
```

Sets the line-break style.

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ||
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `lineBreakStyle` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The new line-break style. Value is[android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_NONE](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_STYLE_NONE:kotlin.Int),[android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_LOOSE](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_STYLE_LOOSE:kotlin.Int),[android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_NORMAL](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_STYLE_NORMAL:kotlin.Int),[android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_STRICT](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_STYLE_STRICT:kotlin.Int),[android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_UNSPECIFIED](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_STYLE_UNSPECIFIED:kotlin.Int),[android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_NO_BREAK](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_STYLE_NO_BREAK:kotlin.Int), or[android.graphics.text.LineBreakConfig#LINE_BREAK_STYLE_AUTO](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_STYLE_AUTO:kotlin.Int) |

|                                                                                Return                                                                                ||
|--------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| [LineBreakConfig.Builder](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#) | This`Builder`. This value cannot be`null`. |

**See Also**

### setLineBreakWordStyle

Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setLineBreakWordStyle(lineBreakWordStyle: Int): LineBreakConfig.Builder
```

Sets the line-break word style.

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ||
|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `lineBreakWordStyle` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The new line-break word style. Value is[android.graphics.text.LineBreakConfig#LINE_BREAK_WORD_STYLE_NONE](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_WORD_STYLE_NONE:kotlin.Int),[android.graphics.text.LineBreakConfig#LINE_BREAK_WORD_STYLE_PHRASE](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_WORD_STYLE_PHRASE:kotlin.Int),[android.graphics.text.LineBreakConfig#LINE_BREAK_WORD_STYLE_UNSPECIFIED](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_WORD_STYLE_UNSPECIFIED:kotlin.Int), or[android.graphics.text.LineBreakConfig#LINE_BREAK_WORD_STYLE_AUTO](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig#LINE_BREAK_WORD_STYLE_AUTO:kotlin.Int) |

|                                                                                Return                                                                                ||
|--------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| [LineBreakConfig.Builder](https://developer.android.com/reference/kotlin/android/graphics/text/LineBreakConfig.Builder#) | This`Builder`. This value cannot be`null`. |

**See Also**