java.lang.Object
- net.minecraftforge.common.data.SoundDefinitionsProvider

All Implemented Interfaces:

IDataProvider

Direct Known Subclasses:

DataGeneratorTest.SoundDefinitions
```
public abstract class SoundDefinitionsProvider
extends java.lang.Object
implements IDataProvider
```
Data provider for the sounds.json file, which identifies sound definitions for the various sound events in Minecraft.

Field Summary

Fields
Modifier and Type	Field	Description
`private DataGenerator`	`generator`
`private static com.google.gson.Gson`	`GSON`
`private ExistingFileHelper`	`helper`
`private static org.apache.logging.log4j.Logger`	`LOGGER`
`private java.lang.String`	`modId`
`private java.util.Map<java.lang.String,SoundDefinition>`	`sounds`

Fields inherited from interface net.minecraft.data.IDataProvider
SHA1

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`SoundDefinitionsProvider(DataGenerator generator, java.lang.String modId, ExistingFileHelper helper)`	Creates a new instance of this data provider.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`add(java.lang.String soundEvent, SoundDefinition definition)`	Adds the `SoundEvent` with the specified name along with its `SoundDefinition` to the list.
`protected void`	`add(java.util.function.Supplier<SoundEvent> soundEvent, SoundDefinition definition)`	Adds the entry name associated with the supplied `SoundEvent` with the given `SoundDefinition` to the list.
`protected void`	`add(ResourceLocation soundEvent, SoundDefinition definition)`	Adds the `SoundEvent` referenced by the given `ResourceLocation` with the `SoundDefinition` to the list.
`protected void`	`add(SoundEvent soundEvent, SoundDefinition definition)`	Adds the entry name associated with the given `SoundEvent` with the `SoundDefinition` to the list.
`private void`	`addSounds(java.lang.String soundEvent, SoundDefinition definition)`
`protected static SoundDefinition`	`definition()`	Creates a new `SoundDefinition`, which will host a set of `SoundDefinition.Sound`s and the necessary parameters.
`java.lang.String`	`getName()`
`private com.google.gson.JsonObject`	`mapToJson(java.util.Map<java.lang.String,SoundDefinition> map)`
`abstract void`	`registerSounds()`	Registers the sound definitions that should be generated via one of the `add` methods.
`void`	`run(DirectoryCache cache)`
`private void`	`save(DirectoryCache cache, java.nio.file.Path targetFile)`
`protected static SoundDefinition.Sound`	`sound(java.lang.String name)`	Creates a new sound with the given name and `SoundDefinition.SoundType.SOUND` as sound type.
`protected static SoundDefinition.Sound`	`sound(java.lang.String name, SoundDefinition.SoundType type)`	Creates a new sound with the given name and type.
`protected static SoundDefinition.Sound`	`sound(ResourceLocation name)`	Creates a new sound with the given name and `SoundDefinition.SoundType.SOUND` as sound type.
`protected static SoundDefinition.Sound`	`sound(ResourceLocation name, SoundDefinition.SoundType type)`	Creates a new sound with the given name and type.
`private void`	`validate()`
`private boolean`	`validate(java.lang.String name, SoundDefinition def)`
`private boolean`	`validate(java.lang.String name, SoundDefinition.Sound sound)`
`private boolean`	`validateEvent(java.lang.String soundName, ResourceLocation name)`
`private boolean`	`validateSound(java.lang.String soundName, ResourceLocation name)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

private static final org.apache.logging.log4j.Logger LOGGER

GSON

private static final com.google.gson.Gson GSON

generator
```
private final DataGenerator generator
```

modId
```
private final java.lang.String modId
```

helper

private final ExistingFileHelper helper

sounds

private final java.util.Map<java.lang.String,SoundDefinition> sounds

Constructor Detail
- SoundDefinitionsProvider
```
protected SoundDefinitionsProvider(DataGenerator generator,
                                   java.lang.String modId,
                                   ExistingFileHelper helper)
```
  Creates a new instance of this data provider.
  
  Parameters:
  
  generator - The data generator instance provided by the event you are initializing this provider in.
  
  modId - The mod ID of the current mod.
  
  helper - The existing file helper provided by the event you are initializing this provider in.

Method Detail
- registerSounds
```
public abstract void registerSounds()
```
  Registers the sound definitions that should be generated via one of the add methods.
- run
```
public void run(DirectoryCache cache)
         throws java.io.IOException
```
  Specified by:
  
  run in interface IDataProvider
  
  Throws:
  
  java.io.IOException
- getName
```
public java.lang.String getName()
```
  Specified by:
  
  getName in interface IDataProvider
- definition
```
protected static SoundDefinition definition()
```
  Creates a new SoundDefinition, which will host a set of SoundDefinition.Sounds and the necessary parameters.
- sound
```
protected static SoundDefinition.Sound sound(ResourceLocation name,
                                             SoundDefinition.SoundType type)
```
  Creates a new sound with the given name and type.
  
  Parameters:
  
  name - The name of the sound to create.
  
  type - The type of sound to create.
- sound
```
protected static SoundDefinition.Sound sound(ResourceLocation name)
```
  Creates a new sound with the given name and SoundDefinition.SoundType.SOUND as sound type.
  
  Parameters:
  
  name - The name of the sound to create.
- sound
```
protected static SoundDefinition.Sound sound(java.lang.String name,
                                             SoundDefinition.SoundType type)
```
  Creates a new sound with the given name and type.
  
  Parameters:
  
  name - The name of the sound to create.
  
  type - The type of sound to create.
- sound
```
protected static SoundDefinition.Sound sound(java.lang.String name)
```
  Creates a new sound with the given name and SoundDefinition.SoundType.SOUND as sound type.
  
  Parameters:
  
  name - The name of the sound to create.
- add
```
protected void add(java.util.function.Supplier<SoundEvent> soundEvent,
                   SoundDefinition definition)
```
  Adds the entry name associated with the supplied SoundEvent with the given SoundDefinition to the list.
  This method should be preferred when dealing with a RegistryObject or RegistryDelegate.
  
  Parameters:
  
  soundEvent - A Supplier for the given SoundEvent.
  
  definition - A SoundDefinition that defines the given sound.
- add
```
protected void add(SoundEvent soundEvent,
                   SoundDefinition definition)
```
  Adds the entry name associated with the given SoundEvent with the SoundDefinition to the list.
  This method should be preferred when a SoundEvent is already available in the method context. If you already have a Supplier for it, refer to add(Supplier, SoundDefinition).
  
  Parameters:
  
  soundEvent - A SoundEvent.
  
  definition - The SoundDefinition that defines the given event.
- add
```
protected void add(ResourceLocation soundEvent,
                   SoundDefinition definition)
```
  Adds the SoundEvent referenced by the given ResourceLocation with the SoundDefinition to the list.
  
  Parameters:
  
  soundEvent - The ResourceLocation that identifies the event.
  
  definition - The SoundDefinition that defines the given event.
- add
```
protected void add(java.lang.String soundEvent,
                   SoundDefinition definition)
```
  Adds the SoundEvent with the specified name along with its SoundDefinition to the list.
  The given sound event must NOT contain the namespace the name is a part of, since the sound definition specification doesn't allow sounds to be defined outside the namespace they're in. For this reason, any namespace will automatically be stripped from the name.
  
  Parameters:
  
  soundEvent - The name of the SoundEvent.
  
  definition - The SoundDefinition that defines the given event.
- addSounds
```
private void addSounds(java.lang.String soundEvent,
                       SoundDefinition definition)
```
- validate
```
private void validate()
```
- validate
```
private boolean validate(java.lang.String name,
                         SoundDefinition def)
```
- validate
```
private boolean validate(java.lang.String name,
                         SoundDefinition.Sound sound)
```
- validateSound
```
private boolean validateSound(java.lang.String soundName,
                              ResourceLocation name)
```
- validateEvent
```
private boolean validateEvent(java.lang.String soundName,
                              ResourceLocation name)
```
- save
```
private void save(DirectoryCache cache,
                  java.nio.file.Path targetFile)
           throws java.io.IOException
```
  Throws:
  
  java.io.IOException
- mapToJson
```
private com.google.gson.JsonObject mapToJson(java.util.Map<java.lang.String,SoundDefinition> map)
```

Class SoundDefinitionsProvider

Field Summary

Fields inherited from interface net.minecraft.data.IDataProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

GSON

generator

modId

helper

sounds

Constructor Detail

SoundDefinitionsProvider

Method Detail

registerSounds

run

getName

definition

sound

sound

sound

sound

add

add

add

add

addSounds

validate

validate

validate

validateSound

validateEvent

save

mapToJson