bin/Be.Stateless.Dsl.Configuration.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Be.Stateless.Dsl.Configuration</name> </assembly> <members> <member name="T:Be.Stateless.Dsl.Configuration.ClrBitness"> <summary> Used to specify the targeted bitness of the .NET Framework. </summary> <seealso href="https://docs.microsoft.com/en-us/dotnet/api/microsoft.build.utilities.dotnetframeworkarchitecture">DotNetFrameworkArchitecture Enum</seealso> </member> <member name="F:Be.Stateless.Dsl.Configuration.ClrBitness.Bitness32"> <summary> Indicates the 32-bit .NET Framework. </summary> </member> <member name="F:Be.Stateless.Dsl.Configuration.ClrBitness.Bitness64"> <summary> Indicates the 64-bit .NET Framework. </summary> </member> <member name="M:Be.Stateless.Dsl.Configuration.ConfigurationElement.Apply(Be.Stateless.Dsl.Configuration.SpecificationElement)"> <summary> Apply the children <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/>s of the <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> <paramref name="specificationElement"/> to the children of the current <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> while transforming —rewriting in place— the <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/>s into their inverse —undo— <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/>s on the fly. </summary> <param name="specificationElement"> The <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> whose children <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/>s will be applied to the current <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/>. </param> <exception cref="T:System.InvalidOperationException"> If a child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> of the <paramref name="specificationElement"/> cannot be applied because it conflicts with an existing child of the current <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/>. </exception> <remarks> <para> The children of the <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> <paramref name="specificationElement"/> being applied are crawled according to a depth-first search path. Then, for each child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> being applied, its processing will happen according to its <see cref="P:Be.Stateless.Dsl.Configuration.SpecificationElement.Operation"/> and whether the current <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> has a child <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> satisfying or equating this child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/>. </para> <para> If the current <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> has no child <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> that satisfies or equates the child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> being applied and the <see cref="P:Be.Stateless.Dsl.Configuration.SpecificationElement.Operation">SpecificationElement.Operation</see> is <list type="bullet"> <item> an <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.INSERT"/> or <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.UPSERT"/> operation, then a new <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> with the specified name and attributes will be inserted and the child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> being applied will be transformed into its inverse <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> with a <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.DELETE"/> operation. </item> <item> an <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.UPDATE"/> operation, then an <see cref="T:System.InvalidOperationException"/> will be thrown. </item> <item> a <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.DELETE"/> operation, then no child <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> will be deleted and the child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> being applied will be transformed into its inverse <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> with a <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.NONE"/> operation. </item> </list> </para> <para> If the current <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> has one child <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> that equates the child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> being applied and the <see cref="P:Be.Stateless.Dsl.Configuration.SpecificationElement.Operation">SpecificationElement.Operation</see> is <list type="bullet"> <item> an <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.INSERT"/> operation, then the equating child <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> will be left untouched and the child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> being applied will be transformed into its inverse <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> with a <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.NONE"/> operation. </item> <item> an <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.UPDATE"/> or <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.UPSERT"/> operation, then, depending on whether attributes of the equating child <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> would have to be scrapped or not, the child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> being applied will be transformed into its inverse <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> with either an <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.UPDATE"/> or a <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.NONE"/> operation. </item> <item> a <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.DELETE"/> operation, then the equating child <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> will be deleted and the child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> being applied will be transformed into its inverse <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> with a <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.INSERT"/> operation. </item> </list> <para> </para> If the current <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> has one child <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> that satisfies but does not equate the child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> being applied and the <see cref="P:Be.Stateless.Dsl.Configuration.SpecificationElement.Operation">SpecificationElement.Operation</see> is <list type="bullet"> <item> an <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.INSERT"/> or a <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.DELETE"/> operation, then an <see cref="T:System.InvalidOperationException"/> will be thrown. </item> <item> an <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.UPDATE"/> or <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.UPSERT"/> operation, then, depending on whether attributes of the equating child <see cref="T:Be.Stateless.Dsl.Configuration.ConfigurationElement"/> would have to be updated or not, the child <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> being applied will be transformed into its inverse <see cref="T:Be.Stateless.Dsl.Configuration.SpecificationElement"/> with either an <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.UPDATE"/> or a <see cref="F:Be.Stateless.Dsl.Configuration.Specification.Annotations.Operation.NONE"/> operation. </item> </list> </para> </remarks> <seealso cref="M:Be.Stateless.Dsl.Configuration.SpecificationElement.IsEquatedBy(Be.Stateless.Dsl.Configuration.ConfigurationElement)"/> <seealso cref="M:Be.Stateless.Dsl.Configuration.SpecificationElement.IsSatisfiedBy(Be.Stateless.Dsl.Configuration.ConfigurationElement)"/> </member> <member name="M:Be.Stateless.Dsl.Configuration.Specification.GetTargetConfigurationFiles"> <summary> Read the value of the mandatory root's <c>targetConfigurationFiles</c> attribute, i.e. <c>{urn:schemas.stateless.be:dsl:configuration:annotations:2020}targetConfigurationFiles</c>. </summary> <returns> The list of distinct target configuration files, possibly monikers. </returns> <exception cref="T:System.InvalidOperationException"> When the attribute is not present at the root element. </exception> <remarks> Multiple files can be separated by a <c>|</c> character. </remarks> <seealso cref="T:Be.Stateless.Dsl.Configuration.Resolver.IConfigurationFileResolverStrategy"/> </member> </members> </doc> |