Package security.whisper.javastix.coo.objects

Class Directory

java.lang.Object
security.whisper.javastix.coo.objects.Directory
All Implemented Interfaces:
Serializable, BundleableObject, Stix, StixCustomProperties, CyberObservableObject, CyberObservableObjectCommonProperties, DirectoryCoo, GenericValidation, SdoDefaultValidator
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class Directory extends Object implements DirectoryCoo
directory

The Directory Object represents the properties common to a file system directory.

See Also:

  • Method Details

    • getPath

      @JsonPropertyDescription("Specifies the path, as originally observed, to the directory on the file system.") public String getPath()
      Specified by:
      getPath in interface DirectoryCoo
      Returns:
      The value of the path attribute

    • getPathEnc

      @JsonPropertyDescription("Specifies the observed encoding for the path.") public Optional<String> getPathEnc()
      This value MUST be specified using the corresponding name from the 2013-12-20 revision of the IANA character set registry.
      Specified by:
      getPathEnc in interface DirectoryCoo

    • getCreated

      @JsonPropertyDescription("Specifies the date/time the directory was created.") public Optional<StixInstant> getCreated()
      Specified by:
      getCreated in interface DirectoryCoo
      Returns:
      The value of the created attribute

    • getModified

      @JsonPropertyDescription("Specifies the date/time the directory was last written to/modified.") public Optional<StixInstant> getModified()
      Specified by:
      getModified in interface DirectoryCoo
      Returns:
      The value of the modified attribute

    • getAccessed

      @JsonPropertyDescription("Specifies the date/time the directory was last accessed.") public Optional<StixInstant> getAccessed()
      Specified by:
      getAccessed in interface DirectoryCoo
      Returns:
      The value of the accessed attribute

    • getId

      public String getId()
      Deterministically generates the ID for this directory based on its path.
      Specified by:
      getId in interface BundleableObject
      Specified by:
      getId in interface CyberObservableObjectCommonProperties
      Specified by:
      getId in interface DirectoryCoo

    • getType

      public String getType()
      Specified by:
      getType in interface BundleableObject
      Specified by:
      getType in interface CyberObservableObjectCommonProperties
      Returns:
      The value of the type attribute

    • getExtensions

      @JsonPropertyDescription("Specifies any extensions of the object, as a dictionary.") public com.google.common.collect.ImmutableSet<CyberObservableExtension> getExtensions()
      Multiple extensions can be added, but only 1 instance of a specific extension can be added.
      Specified by:
      getExtensions in interface CyberObservableObjectCommonProperties

    • getObservableObjectKey

      public String getObservableObjectKey()
      Used for generation of Map Keys by
      invalid reference 
      ObservedDataSdo#getObjects()
      Manually set this value if you want to control key names. Otherwise UUIDs will be used.
      Specified by:
      getObservableObjectKey in interface CyberObservableObjectCommonProperties

    • getDefanged

      @JsonPropertyDescription("Indicates whether the data contained in the SCO has been defanged.") public Optional<Boolean> getDefanged()
      Indicates whether the data contained in the SCO has been defanged. Defanging refers to the process of modifying data to make it safe to handle (e.g., changing an IP address from 192.168.1.1 to 192[.]168[.]1[.]1).
      Specified by:
      getDefanged in interface CyberObservableObjectCommonProperties

    • getCustomProperties

      public com.google.common.collect.ImmutableMap<String,Object> getCustomProperties()
      Custom Properties for STIX Objects. Any object that supports custom properties will have a validation of the custom property prefix (typically "x_"). If the additional property in the JSON does not meet the StartsWith condition, then the JSON will be rejected.
      Specified by:
      getCustomProperties in interface StixCustomProperties
      Returns:
      Map of custom properties Map<String, Object>

    • getObjectMarkingRefs

      public com.google.common.collect.ImmutableSet<MarkingDefinitionDm> getObjectMarkingRefs()
      Specified by:
      getObjectMarkingRefs in interface BundleableObject
      Returns:
      The value of the objectMarkingRefs attribute

    • getGranularMarkings

      public com.google.common.collect.ImmutableSet<GranularMarkingDm> getGranularMarkings()
      Specified by:
      getGranularMarkings in interface BundleableObject
      Returns:
      The value of the granularMarkings attribute

    • getHydrated

      public boolean getHydrated()
      Specified by:
      getHydrated in interface BundleableObject
      Returns:
      The value of the hydrated attribute

    • toJsonString

      public String toJsonString()
      Specified by:
      toJsonString in interface BundleableObject
      Returns:
      The value of the toJsonString attribute

    • withPath

      public final Directory withPath(String value)
      Copy the current immutable object by setting a value for the path attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for path (can be null)
      Returns:
      A modified copy of the this object

    • withPathEnc

      public final Directory withPathEnc(String value)
      Copy the current immutable object by setting a present value for the optional pathEnc attribute.
      Parameters:
      value - The value for pathEnc
      Returns:
      A modified copy of this object

    • withPathEnc

      public final Directory withPathEnc(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the pathEnc attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for pathEnc
      Returns:
      A modified copy of this object

    • withCreated

      public final Directory withCreated(StixInstant value)
      Copy the current immutable object by setting a present value for the optional created attribute.
      Parameters:
      value - The value for created
      Returns:
      A modified copy of this object

    • withCreated

      public final Directory withCreated(Optional<? extends StixInstant> optional)
      Copy the current immutable object by setting an optional value for the created attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for created
      Returns:
      A modified copy of this object

    • withModified

      public final Directory withModified(StixInstant value)
      Copy the current immutable object by setting a present value for the optional modified attribute.
      Parameters:
      value - The value for modified
      Returns:
      A modified copy of this object

    • withModified

      public final Directory withModified(Optional<? extends StixInstant> optional)
      Copy the current immutable object by setting an optional value for the modified attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for modified
      Returns:
      A modified copy of this object

    • withAccessed

      public final Directory withAccessed(StixInstant value)
      Copy the current immutable object by setting a present value for the optional accessed attribute.
      Parameters:
      value - The value for accessed
      Returns:
      A modified copy of this object

    • withAccessed

      public final Directory withAccessed(Optional<? extends StixInstant> optional)
      Copy the current immutable object by setting an optional value for the accessed attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for accessed
      Returns:
      A modified copy of this object

    • withType

      public final Directory withType(String value)
      Copy the current immutable object by setting a value for the type attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for type (can be null)
      Returns:
      A modified copy of the this object

    • withExtensions

      public final Directory withExtensions(CyberObservableExtension... elements)
      Copy the current immutable object with elements that replace the content of extensions.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withExtensions

      public final Directory withExtensions(Iterable<? extends CyberObservableExtension> elements)
      Copy the current immutable object with elements that replace the content of extensions. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of extensions elements to set
      Returns:
      A modified copy of this object

    • withObservableObjectKey

      public final Directory withObservableObjectKey(String value)
      Copy the current immutable object by setting a value for the observableObjectKey attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for observableObjectKey
      Returns:
      A modified copy of the this object

    • withDefanged

      public final Directory withDefanged(boolean value)
      Copy the current immutable object by setting a present value for the optional defanged attribute.
      Parameters:
      value - The value for defanged
      Returns:
      A modified copy of this object

    • withDefanged

      public final Directory withDefanged(Optional<Boolean> optional)
      Copy the current immutable object by setting an optional value for the defanged attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for defanged
      Returns:
      A modified copy of this object

    • withCustomProperties

      public final Directory withCustomProperties(Map<String,? extends Object> entries)
      Copy the current immutable object by replacing the customProperties map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      entries - The entries to be added to the customProperties map
      Returns:
      A modified copy of this object

    • withObjectMarkingRefs

      public final Directory withObjectMarkingRefs(MarkingDefinitionDm... elements)
      Copy the current immutable object with elements that replace the content of objectMarkingRefs.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withObjectMarkingRefs

      public final Directory withObjectMarkingRefs(Iterable<? extends MarkingDefinitionDm> elements)
      Copy the current immutable object with elements that replace the content of objectMarkingRefs. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of objectMarkingRefs elements to set
      Returns:
      A modified copy of this object

    • withGranularMarkings

      public final Directory withGranularMarkings(GranularMarkingDm... elements)
      Copy the current immutable object with elements that replace the content of granularMarkings.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withGranularMarkings

      public final Directory withGranularMarkings(Iterable<? extends GranularMarkingDm> elements)
      Copy the current immutable object with elements that replace the content of granularMarkings. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of granularMarkings elements to set
      Returns:
      A modified copy of this object

    • withHydrated

      public final Directory withHydrated(boolean value)
      Copy the current immutable object by setting a value for the hydrated attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for hydrated
      Returns:
      A modified copy of the this object

    • withToJsonString

      public final Directory withToJsonString(String value)
      Copy the current immutable object by setting a value for the toJsonString attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for toJsonString (can be null)
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of Directory that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: path, pathEnc, created, modified, accessed, id, type, extensions, observableObjectKey, defanged, customProperties, objectMarkingRefs, granularMarkings, hydrated, toJsonString.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value Directory with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static Directory copyOf(DirectoryCoo instance)
      Creates an immutable copy of a DirectoryCoo value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable Directory instance

    • builder

      public static Directory.Builder builder()
      Creates a builder for Directory.
      Returns:
      A new Directory builder