java.lang.Object
- jmri.jmrit.whereused.WhereUsedCollectors

```
public class WhereUsedCollectors
extends java.lang.Object
```
Find references. Each collector method calls a corresponding getUsageReport(NamedBean) in the main implementation class for the object type. The matches are returned in an array list of NamedBeanUsageReport objects. Collectors:
- checkAudio
- checkTurnouts
- checkLights
- checkRoutes
- checkBlocks
- checkLayoutBlocks
- checkSignalHeadLogic
- checkSignalMastLogic
- checkSignalGroups
- checkSignalHeads
- checkSignalMasts
- checkOBlocks
- checkWarrants
- checkEntryExit
- checkLogixConditionals
- checkLogixNGConditionals
- checkSections
- checkTransits
- checkPanels
- checkCTC

Field Summary

Fields
Modifier and Type Field Description

(package private) static CtcManager mgr

Constructor Summary

Constructors
Constructor Description

WhereUsedCollectors()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) static java.lang.String`	`addHeader(java.lang.StringBuilder sb, java.lang.String bundleKey)`	Add the specified section to the beginning of the string builder if there is data.
`(package private) static java.lang.String`	`checkAudio(NamedBean bean)`	Create the Audio usage string.
`(package private) static java.lang.String`	`checkBlocks(NamedBean bean)`	Create the Block usage string.
`(package private) static java.lang.String`	`checkCTC(NamedBean bean)`	Create the CTC usage string.
`(package private) static java.lang.String`	`checkEntryExit(NamedBean bean)`	Create the Entry/Exit usage string.
`(package private) static java.lang.String`	`checkLayoutBlocks(NamedBean bean)`	Create the LayoutBlock usage string.
`(package private) static java.lang.String`	`checkLights(NamedBean bean)`	Create the Light usage string.
`(package private) static java.lang.String`	`checkLogixConditionals(NamedBean bean)`	Create the Logix/Conditional usage string.
`(package private) static java.lang.String`	`checkLogixNGConditionals(NamedBean bean)`	Create the LogixNG/ConditionalNG usage string.
`(package private) static java.lang.String`	`checkOBlocks(NamedBean bean)`	Create the OBlock usage string.
`(package private) static java.lang.String`	`checkPanels(NamedBean bean)`	Create the Panel usage string.
`(package private) static java.lang.String`	`checkRoutes(NamedBean bean)`	Create the Route usage string.
`(package private) static java.lang.String`	`checkSections(NamedBean bean)`	Create the Section usage string.
`(package private) static java.lang.String`	`checkSignalGroups(NamedBean bean)`	Create the Signal Group usage string.
`(package private) static java.lang.String`	`checkSignalHeadLogic(NamedBean bean)`	Create the Signal Head Logic usage string.
`(package private) static java.lang.String`	`checkSignalHeads(NamedBean bean)`	Create the Signal Head usage string.
`(package private) static java.lang.String`	`checkSignalMastLogic(NamedBean bean)`	Create the Signal Mast Logic usage string.
`(package private) static java.lang.String`	`checkSignalMasts(NamedBean bean)`	Create the Signal Mast usage string.
`(package private) static java.lang.String`	`checkTransits(NamedBean bean)`	Create the Transit usage string.
`(package private) static java.lang.String`	`checkTurnouts(NamedBean bean)`	Create the Turnout usage string.
`(package private) static java.lang.String`	`checkWarrants(NamedBean bean)`	Create the Warrant usage string.

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

- Field Detail
  - mgr
```
static CtcManager mgr
```
- Constructor Detail
  - WhereUsedCollectors
```
public WhereUsedCollectors()
```
- Method Detail
  - checkAudio
```
static java.lang.String checkAudio(NamedBean bean)
```
    Create the Audio usage string. Usage keys:
    
    AudioBuffer
    Parameters:
    
    bean - The requesting bean: Audio.
    
    Returns:
    
    usage string
  - checkTurnouts
```
static java.lang.String checkTurnouts(NamedBean bean)
```
    Create the Turnout usage string. Usage keys:
    
    TurnoutFeedback1
    
    TurnoutFeedback2
    Parameters:
    
    bean - The requesting bean: Sensor.
    
    Returns:
    
    usage string
  - checkLights
```
static java.lang.String checkLights(NamedBean bean)
```
    Create the Light usage string. Usage keys:
    
    LightControlSensor1
    
    LightControlSensor2
    
    LightControlSensorTimed
    
    LightControlTurnout
    Parameters:
    
    bean - The requesting bean: Sensor, Turnout.
    
    Returns:
    
    usage string
  - checkRoutes
```
static java.lang.String checkRoutes(NamedBean bean)
```
    Create the Route usage string. Usage keys:
    
    RouteTurnoutOutput
    
    RouteSensorOutput
    
    RouteSensorControl
    
    RouteSensorAligned
    
    RouteTurnoutControl
    
    RouteTurnoutLock
    Parameters:
    
    bean - The requesting bean: Sensor, Turnout.
    
    Returns:
    
    usage string
  - checkBlocks
```
static java.lang.String checkBlocks(NamedBean bean)
```
    Create the Block usage string. Usage keys:
    
    BlockSensor
    
    BlockReporter
    
    BlockPathNeighbor
    
    BlockPathTurnout
    Parameters:
    
    bean - The requesting bean: Block (Path neighbor), Sensor, Reporter, Turnout (Path).
    
    Returns:
    
    usage string
  - checkLayoutBlocks
```
static java.lang.String checkLayoutBlocks(NamedBean bean)
```
    Create the LayoutBlock usage string. Usage keys:
    
    LayoutBlockBlock
    
    LayoutBlockMemory
    
    LayoutBlockSensor
    
    LayoutBlockNeighbor
    Parameters:
    
    bean - The requesting bean: Block, Memory, Sensor.
    
    Returns:
    
    usage string
  - checkSignalHeadLogic
```
static java.lang.String checkSignalHeadLogic(NamedBean bean)
```
    Create the Signal Head Logic usage string. Usage keys:
    
    SSLSignal
    
    SSLSensor1-5
    
    SSLTurnout
    
    SSLSignal1
    
    SSLSignal1Alt
    
    SSLSignal2
    
    SSLSignal2Alt
    
    SSLSensorWatched1
    
    SSLSensorWatched1Alt
    
    SSLSensorWatched2
    
    SSLSensorWatched2Alt
    
    SSLSensorApproach
    Parameters:
    
    bean - The requesting bean: Sensor, Signal Head, Turnout.
    
    Returns:
    
    usage string
  - checkSignalMastLogic
```
static java.lang.String checkSignalMastLogic(NamedBean bean)
```
    Create the Signal Mast Logic usage string. Usage keys:
    
    SMLSourceMast
    
    SMLDestinationMast
    
    SMLBlockAuto
    
    SMLBlockUser
    
    SMLTurnoutAuto
    
    SMLTurnoutUser
    
    SMLSensor
    
    SMLMastAuto
    
    SMLMastUser
    Parameters:
    
    bean - The requesting bean: Block, Turnout, Sensor, Signal Mast.
    
    Returns:
    
    usage string
  - checkSignalGroups
```
static java.lang.String checkSignalGroups(NamedBean bean)
```
    Create the Signal Group usage string. Usage keys:
    
    SignalGroupMast
    
    SignalGroupHead
    
    SignalGroupHeadSensor
    
    SignalGroupHeadTurnout
    Parameters:
    
    bean - The requesting bean: Sensor, Signal Head, Signal Mast, Turnout.
    
    Returns:
    
    usage string
  - checkSignalHeads
```
static java.lang.String checkSignalHeads(NamedBean bean)
```
    Create the Signal Head usage string. Usage keys:
    
    SignalHeadTurnout
    Parameters:
    
    bean - The requesting bean: Turnout.
    
    Returns:
    
    usage string
  - checkSignalMasts
```
static java.lang.String checkSignalMasts(NamedBean bean)
```
    Create the Signal Mast usage string. Usage keys:
    
    SignalMastTurnout
    
    SignalMastSignalHead
    Parameters:
    
    bean - The requesting bean: Signal Head, Turnout.
    
    Returns:
    
    usage string
  - checkOBlocks
```
static java.lang.String checkOBlocks(NamedBean bean)
```
    Create the OBlock usage string. Usage keys:
    
    OBlockSensor
    
    OBlockSensorError
    
    OBlockPortalNeighborOBlock
    
    OBlockPortalSignal
    
    OBlockPortalPathTurnout
    
    OBlockWarrant
    Parameters:
    
    bean - The requesting bean: OBlock (Neightbor), Sensor, SignalHead, SignalMast, Turnout, Warrant.
    
    Returns:
    
    usage string
  - checkWarrants
```
static java.lang.String checkWarrants(NamedBean bean)
```
    Create the Warrant usage string. Usage keys:
    
    WarrantBlocking
    
    WarrantBlock
    
    WarrantSignal
    Parameters:
    
    bean - The requesting bean: OBlock SignalHead, SignalMast, Warrant.
    
    Returns:
    
    usage string
  - checkEntryExit
```
static java.lang.String checkEntryExit(NamedBean bean)
```
    Create the Entry/Exit usage string. Usage keys:
    
    EntryExitSourceSensor
    
    EntryExitSourceSignal
    
    EntryExitDestinationSensor
    
    EntryExitDestinationSignal
    Parameters:
    
    bean - The requesting bean: Sensor SignalHead, SignalMast.
    
    Returns:
    
    usage string
  - checkLogixConditionals
```
static java.lang.String checkLogixConditionals(NamedBean bean)
```
    Create the Logix/Conditional usage string. Usage keys:
    
    ConditionalAction
    
    ConditionalVariable
    
    ConditionalVariableData
    Parameters:
    
    bean - The requesting bean: Many.
    
    Returns:
    
    usage string
  - checkLogixNGConditionals
```
static java.lang.String checkLogixNGConditionals(NamedBean bean)
```
    Create the LogixNG/ConditionalNG usage string. Usage keys:
    
    LogixNGAction
    
    LogixNGExpression
    Parameters:
    
    bean - The requesting bean: Many.
    
    Returns:
    
    usage string
  - checkSections
```
static java.lang.String checkSections(NamedBean bean)
```
    Create the Section usage string. Usage keys:
    
    SectionBlock
    
    SectionSensorForwardBlocking
    
    SectionSensorForwardStopping
    
    SectionSensorReverseBlocking
    
    SectionSensorReverseStopping
    Parameters:
    
    bean - The requesting bean: Block, Sensor.
    
    Returns:
    
    usage string
  - checkTransits
```
static java.lang.String checkTransits(NamedBean bean)
```
    Create the Transit usage string. Usage keys:
    
    TransitSection
    
    TransitSensorStopAllocation
    
    TransitActionSensorWhen
    
    TransitActionSensorWhat
    
    TransitActionSignalHeadWhat
    
    TransitActionSignalMastWhat
    Parameters:
    
    bean - The requesting bean: Section, Sensor, Signal Head, Signal Mast.
    
    Returns:
    
    usage string
  - checkPanels
```
static java.lang.String checkPanels(NamedBean bean)
```
    Create the Panel usage string. The string includes the icon class name. Usage keys:
    
    PositionalIcon
    
    LayoutEditorTurnout
    
    LayoutEditorTurnout2
    
    LayoutEditorTurnoutBlock
    
    LayoutEditorTurnoutSensor
    
    LayoutEditorTurnoutSignalHead
    
    LayoutEditorTurnoutSignalMast
    
    LayoutEditorPointSensor
    
    LayoutEditorPointSignalHead
    
    LayoutEditorPointSignalMast
    
    LayoutEditorSegmentBlock
    
    LayoutEditorXingBlock
    
    LayoutEditorXingOther (sensor, head, mast)
    
    Switchboard (sensor, turnout, light)
    
    Note: The getUsageReport is invoked at either Editor or LayoutEditor depending on the panel type. The LayoutEditor version does a super call and then does special turnout checking since LE turnouts are not icons.
    Parameters:
    
    bean - The requesting bean: Many.
    
    Returns:
    
    usage string
  - checkCTC
```
static java.lang.String checkCTC(NamedBean bean)
```
    Create the CTC usage string. The CTC manager is found using the ConfigureManager instead of the InstanceManager. The CTC manager uses InstanceManagerAutoDefault which can result in unnecessary XML content when CTC is not being used. Usage keys:
    
    CtcWhereUsedOther
    
    CtcWhereUsedCBHD
    Parameters:
    
    bean - The requesting bean: Block, Sensor, Signal Head, Signal Mast, Turnout.
    
    Returns:
    
    usage string
  - addHeader
```
static java.lang.String addHeader(java.lang.StringBuilder sb,
                                  java.lang.String bundleKey)
```
    Add the specified section to the beginning of the string builder if there is data.
    
    Parameters:
    
    sb - The current string builder.
    
    bundleKey - The key for the section header.
    
    Returns:
    
    the resulting string.

Class WhereUsedCollectors

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mgr

Constructor Detail

WhereUsedCollectors

Method Detail

checkAudio

checkTurnouts

checkLights

checkRoutes

checkBlocks

checkLayoutBlocks

checkSignalHeadLogic

checkSignalMastLogic

checkSignalGroups

checkSignalHeads

checkSignalMasts

checkOBlocks

checkWarrants

checkEntryExit

checkLogixConditionals

checkLogixNGConditionals

checkSections

checkTransits

checkPanels

checkCTC

addHeader