Class KeyToPath

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.Model

    public class KeyToPath
    extends java.lang.Object
    implements com.marcnuri.yakc.model.Model
    Maps a string key to a path within a volume.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  KeyToPath.Builder  
    • Constructor Summary

      Constructors 
      Constructor Description
      KeyToPath()  
      KeyToPath​(@NonNull java.lang.String key, java.lang.Number mode, @NonNull java.lang.String path)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static KeyToPath.Builder builder()  
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      @NonNull java.lang.String getKey()
      key is the key to project.
      java.lang.Number getMode()
      mode is Optional: mode bits used to set permissions on this file.
      @NonNull java.lang.String getPath()
      path is the relative path of the file to map the key to.
      int hashCode()  
      void setKey​(@NonNull java.lang.String key)
      key is the key to project.
      void setMode​(java.lang.Number mode)
      mode is Optional: mode bits used to set permissions on this file.
      void setPath​(@NonNull java.lang.String path)
      path is the relative path of the file to map the key to.
      KeyToPath.Builder toBuilder()  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • KeyToPath

        public KeyToPath​(@NonNull
                         @NonNull java.lang.String key,
                         java.lang.Number mode,
                         @NonNull
                         @NonNull java.lang.String path)
      • KeyToPath

        public KeyToPath()
    • Method Detail

      • getKey

        @NonNull
        public @NonNull java.lang.String getKey()
        key is the key to project.
      • getMode

        public java.lang.Number getMode()
        mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
      • getPath

        @NonNull
        public @NonNull java.lang.String getPath()
        path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
      • setKey

        public void setKey​(@NonNull
                           @NonNull java.lang.String key)
        key is the key to project.
      • setMode

        public void setMode​(java.lang.Number mode)
        mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
      • setPath

        public void setPath​(@NonNull
                            @NonNull java.lang.String path)
        path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • canEqual

        protected boolean canEqual​(java.lang.Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object